diff --git a/README.md b/README.md index f095a905..cfdddd8d 100644 --- a/README.md +++ b/README.md @@ -114,12 +114,6 @@ Then fill `.env` with the omitted values (ask in Zulip). At the moment of this w ### Start the API/Backend -Start the server: - -```bash -poetry run python -m reflector.app -``` - Start the background worker: ```bash @@ -135,6 +129,14 @@ redis-server ### Redis (Windows) +**Option 1** + +```bash +docker compose up -d redis +``` + +**Option 2** + Install: - [Git for Windows](https://gitforwindows.org/) - [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/install) @@ -147,6 +149,20 @@ sudo apt install redis-server redis-server ``` +## Update the database schema (run on first install, and after each pull containing a migration) + +```bash +poetry run python alembic head +``` + +## Main Server + +Start the server: + +```bash +poetry run python -m reflector.app +``` + ### Crontab (optional) For crontab (only healthcheck for now), start the celery beat (you don't need it on your local dev environment):