Skip to content

Getting Started

The Getting Started section provides everything you need to set up the project for local development. It includes instructions for installing and using the key tools required to work with our codebase:

  • uv: Used to manage the backend, run the documentation server, and set up pre-commit hooks.
  • npm: Required to install dependencies, run the frontend development server, and build the production frontend using React and Vite.
  • Project Documentation: Learn how to serve and view the documentation locally with live-reloading and optional encryption.

uv

We use uv as a central tool to manage and run various parts of this project — including:

  • Installing and running pre-commit hooks
  • Managing the backend environment
  • Serving and building the documentation

Make sure uv is installed and ready to use before continuing with any other setup steps.

You can find installation instructions and usage details in the official uv Getting Started Guide.

npm

Our frontend is built with React and Vite, and requires npm to install dependencies, run the development server, and create production builds.

You’ll need npm set up before working on the frontend.

Please make sure you have Node.js (which includes npm) installed. You can download it from the official Node.js website.

To verify your installation:

node --version
npm --version

For details on how we structure and run the frontend, see the relevant sections in this documentation.

Documentation

Our documentation is written in Markdown and built using MKDocs.

Start the Development Server

To run the documentation server locally, use the following command:

uv run --only-group docs mkdocs serve

Once started, open http://localhost:8000 in your browser to view the documentation. The server supports live reloading — any changes to the Markdown files will automatically refresh the browser.

Updating the Online Documentation

The production documentation is deployed through a GitHub Action. To update it, trigger the "Deploy Docs" workflow manually from the Actions tab on GitHub. Make sure your changes are committed and pushed to the appropriate branch before triggering the workflow.