This guide gets the API and ingestion worker running locally.

1) Install dependencies

pnpm --dir backend install

2) Configure environment

The config module loads .env.<NODE_ENV>.local and .env from the repo root. Create a .env file and set at least the required variables.

See the full list in Environment variables.

3) Start the API

pnpm --dir backend run start:api:dev

The API listens on PORT (default 3000).

  • Health check: GET /healthz
  • Swagger UI: GET /docs
  • API prefix: api/v1 (see Configuration)

4) Start the ingestion worker

pnpm --dir backend run start:worker:dev

The worker listens on WORKER_HEALTH_PORT (default 3001) for health checks.

Common commands

pnpm --dir backend run lint
pnpm --dir backend run test
pnpm --dir backend run build
pnpm --dir backend run verify