Skip to content

Development

For most development, run the full Docker Compose stack from the repository root.

docker compose up --build

API

From api/:

cargo run

The API expects PostgreSQL, Redis, S3 credentials, S3_BUCKET, and JWT_SECRET to be available in the environment.

Run API tests:

cargo test

UI

From ui/:

npm install
npm run dev

Build the UI:

npm run build

Lint the UI:

npm run lint

Documentation

Install documentation dependencies from the repository root:

pip install -r requirements-docs.txt

Build the documentation site:

mkdocs build --strict

Serve the documentation locally:

mkdocs serve