Skip to content

update readme to include compose instructions #23

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

Merged
berat-552 merged 1 commit into from
Jul 5, 2025
Merged

update readme to include compose instructions #23

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down