TODO: Summary
Copy .env.example
to .env
and replace the placeholders with real values.
To run in development mode (with auto-reloading):
docker-compose up backend-dev
To run in production mode:
docker-compose up backend
and go to http://localhost:8000
Use poetry
to update dependencies, instead of modifying pyproject.toml
directly. This can be done using the poetry
service in docker-compose.yaml
.
Images should then be re-built to include the updated dependencies.
Add a dependency
docker-compose run --rm poetry add <SOME-DEPENDENCY>
docker-compose build
Should be run locally before pushing, and are validated by Github Actions. Tests will fail if unit test coverage is less than 95%.
docker-compose run --rm lint
docker-compose run --rm test