From 66f153eff594a6b5106a73587ee567949bb1070a Mon Sep 17 00:00:00 2001 From: berat-552 Date: Sat, 5 Jul 2025 13:46:28 +0100 Subject: [PATCH] update readme to include compose instructions --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index cf2f555..f565401 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,25 @@ When the GUI closes, the container is stopped automatically. ```bash make docker-stop ``` + +#### 🐳 Running with Docker Compose (Hot Reload Dev Setup) +If you want live-reloading of the backend while you develop: + +Start backend (with hot reload) + launch GUI +```bash +make dev-full +``` + +This uses Docker Compose to start the backend with `--reload`, waits a few seconds, then launches the GUI app. +The backend remains running after the GUI closes. + +Make sure you have a `.env` file in your project root. You can copy it from `.env.example` if needed. + +Stop the Docker Compose backend +```bash +make dev-full-down +``` +--- #### 🧪 Running Tests ```bash make test