Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(readme): document frontend dev mode setup #608

Merged
merged 1 commit into from
Aug 26, 2024
Merged

docs(readme): document frontend dev mode setup #608

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,26 @@ This will run Cryostat as a local JVM process hooked up to its frontend, and req

> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8181/q/dev/.

### Run the application with dev mode frontend

You can run the server setup with a live coding frontend instance using:

`terminal 1`
```bash
$ ./smoktest.bash -t
```

`terminal 2`
```bash
$ cd /path/to/cryostat-web # this can be ./src/main/webui , or a separate clone of the cryostat-web repository
$ yarn yarn:frzinstall
$ yarn start:dev
```

This will run Cryostat, required companion services, and test applications in a podman/docker compose container setup. Changes to frontend sources in `/path/to/cryostat-web` will trigger automatic rebuilds and live-coding of the web UI only. This is often useful for frontend development compared to the previous dev mode setup, since it allows for the full suite of test applications to be deployed.

The Quarkus Dev UI is not available in this setup.

## RUN

### Local Smoketesting
Expand Down
Loading