Getting Started

Prerequisites

  • .NET 8 SDK
  • Node 20.x for the frontend (see src/frontend/web/.nvmrc and contributing.md; avoid Node 25+ for npm run build unless you accept possible native-binding gaps)
  • Docker Desktop (optional, for docker compose)
  • Python 3.11+ (for docs)

Run with Docker

make up

This starts api and web only (production-like stack). Browser E2E uses the testing Compose profile and .env.testing; see Contributing — Browser E2E.

  • Web: http://localhost:3000
  • API: http://localhost:3000/api/health

Run backend + frontend in dev mode

Backend:

cd src/backend/PostgresQueryAutopsyTool.Api
dotnet run

Frontend:

cd src/frontend/web
npm ci
npm run dev

Run tests

make test

Build and serve docs locally

python -m venv .venv-docs
source .venv-docs/bin/activate
pip install -r requirements-docs.txt
mkdocs serve