Skip to content

Quickstart

Prerequisites

  • Python 3.12+
  • uv
  • Docker + Docker Compose plugin

Local bootstrap

uv sync --extra dev
cp .env.example .env

Start local stack

docker compose -f docker/docker-compose.yml up -d --build

Default local ports:

  • API: http://localhost:8000
  • Portal UI: http://localhost:8080
  • Admin panel: http://localhost:8010
  • Postgres: localhost:5432
  • Redis: localhost:6379
  • MinIO: localhost:9000 (9001 console)

Apply SQL migrations

docker compose -f docker/docker-compose.yml run --rm api bash scripts/migrate.sh

Run tests

uv run pytest -q tests

Start API without Docker

uv run uvicorn ft.api.app:app --host 0.0.0.0 --port 8000

Start admin panel without Docker

uv run uvicorn ft.admin_panel.app:app --host 0.0.0.0 --port 8010