Skip to main content

Commands Reference

Setup and install

CommandPurpose
make setupCreate env files if missing and install backend/frontend dependencies
make installInstall backend and frontend dependencies
make install-backendBackend dependencies only
make install-frontendFrontend dependencies only

Local development

CommandPurpose
make infraStart Postgres, Redis, and MinIO in Docker
make infra-stopStop infrastructure containers
make infra-downStop and remove infra containers/volumes
make infra-waitWait for infra health
make backend-devRun backend with reload
make frontend-devRun the frontend dev server
make dev-allStart infra plus backend/frontend in one command

Full Docker stack

CommandPurpose
make stackStart the full stack
make stack-buildStart the full stack with image rebuild
make stack-downStop the full stack
make stack-logsTail full-stack logs

Docs

CommandPurpose
make docs-installInstall Docusaurus dependencies
make docs-devRun the docs dev server
make docs-buildBuild the docs site
make docs-servePreview the built docs

Database

CommandPurpose
make db-migrateApply Alembic migrations
make db-revision msg="..."Create a new Alembic revision
make db-downgradeRoll back one migration
make db-historyShow migration history

Lint and format

CommandPurpose
make formatFormat backend and frontend
make lintLint backend and frontend
make format-backendBackend formatting only
make lint-backendBackend lint only

Practical Advice

  • Use make dev-all for most feature work.
  • Use make stack-build when env or container wiring matters.
  • Use make docs-build whenever you change this Docusaurus site.
  • Prefer targeted Python linting on the files you changed before finalizing work.