Skip to content

Local Development

Running the app

# Terminal 1: start the API
cd server && npm run dev

# Terminal 2: start the front end
cd client && npm run dev

Running the docs site locally

The documentation you're reading is built with MkDocs and the Material theme.

pip install -r requirements.txt
mkdocs serve

Then open http://127.0.0.1:8000. The site live-reloads as you edit files under docs/.

Running tests

# fill in once test tooling is decided
npm test

Linting / formatting

Document your chosen tools here (ESLint, Prettier, etc.) once decided as a group.