Quickstart

Short version of the local dev setup. For the full guide — secrets generation, sample data, common commands, troubleshooting — see DEVELOPMENT.md.

Prerequisites

pnpm
uv
Docker + Compose
Just (optional, for command shortcuts)

5-minute setup

Clone and configure

git clone https://github.com/lcmd-epfl/db.git
cd db
cp .env.example .env

Start infra in the background

Postgres, MinIO, Redis — everything below the app layer.

docker compose up -d

Install deps

pnpm install
uv sync --all-extras --all-groups --package lcmd_db

Initialize the database

One shot: migrations, MinIO buckets, superuser, sample data.

just reset_db

Run dev servers with hot reload

pnpm dev

Access points:

Frontend: localhost:3000
Backend admin: localhost:8000/admin
API docs: localhost:8000/api/v1/docs
MinIO console: localhost:9001 (credentials minio/minio123)

Login credentials are whatever you set for DJANGO_SUPERUSER_* in .env.

What next

Architecture — stack, request flow, repo layout
API — how the OpenAPI schema becomes a typed SDK
Testing — pytest + factory setup
Deployment — how code in main becomes prod

Maintainer Documentation

Run, operate, and contribute to the LCMD db platform

Project Architecture

Overview of the LCMD db project structure and dependencies

On this page

Prerequisites 5-minute setup Clone and configure Start infra in the background Install deps Initialize the database Run dev servers with hot reload What next