From 24458bed5c2ad845fe88d3487c3664b13b5e34f2 Mon Sep 17 00:00:00 2001
From: Andrew Azores <me@andrewazor.es>
Date: Mon, 26 Aug 2024 11:28:39 -0400
Subject: [PATCH] docs(readme): document frontend dev mode setup (#608)

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 3edfab6ab..ecfaef71e 100644
--- a/README.md
+++ b/README.md
@@ -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