Skip to content

Commit 0cd7b6f

Browse files
Readme update
1 parent cd272d8 commit 0cd7b6f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

backend/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ And if you want to exclude somewhat noisy changes in virtualenv:
88

99
`uvicorn app.main:app --reload --reload-exclude '.venv/**/*.py'`
1010

11+
A Docker-compose configuration is available to run all parts of the application. To run this:
12+
13+
- [Download the sample data](https://drive.google.com/drive/folders/1U_ee6ADd1HKNTpLCjFmlo4ir8xxWTwRI?usp=sharing)
14+
- Place the data in the root repo folder, by default in a folder called `sample_data`
15+
- In `docker-compose.yml`, set `LOAD_GERRY_DB_DATA` to `true` to ingest data
16+
- Run `docker-compose up --build`
17+
- Change `LOAD_GERRY_DB_DATA` back to false
18+
- On subsequent start ups, simply run `docker-compose up`
19+
1120
## Shipping
1221

1322
Don't forget to update requirements in case you added a new package with `uv pip freeze | uv pip compile - -o requirements.txt`

0 commit comments

Comments
 (0)