Minimal setup

Using Docker

The full dev-setup requires docker.

It is highly recommended to install * just <https://github.com/casey/just/releases> ≥1.23.0

Follow the following guides:

  1. Cloning the repository
  2. Installing Docker and Docker Compose

If you have just installed, just run just setup and follow any leftover instructions.

Alternatively, follow these guides:

  1. Setting environment variables
  2. Starting the containers
  3. Importing the database Dump

And possibly:

Using a python virtual environment (venv)

Prerequisites
  • installed uv

If you only want to build the documentation or run tests, you only need to do the following:

  1. Cloning the repository
  2. Set up a virtual environment
  3. Run tests / Build docs / …