Local development setup
Run the whole stack with Docker.
The fastest way to a working environment is the repository's Docker setup, which brings up every service the product needs.
Start and verify
cp .env.example .env
./scripts/dev-setup.sh up
./scripts/dev-setup.sh testThe compose file in the repository starts the database, Redis, backend, workers, scheduler, Flower and the frontend. Check docker-compose.yml for the ports on your machine.
Docker compose local stack setup
public/docs/images/docs-local-dev-setup.png
Requirements
- Python 3.11+
- Node.js 20+
- Docker with Compose v2
- Chrome (for the extension)
Next steps
With the stack running, see Project structure to orient yourself, and Environment configuration for the settings you can change.