Run from source

Source mode is intended for local development. Use Docker Compose for a persistent deployment.

Backend

Create a virtual environment, install the pinned dependencies, and start the FastAPI backend:

Linux

python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install -r backend/requirements.txt
export PYTHONPATH="$PWD/backend"
export APP_CONFIG_PATH="$PWD/data/config.yml"
uvicorn app.main:app --host 127.0.0.1 --port 8080 --reload

Windows

Run these commands in PowerShell:

py -3.12 -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install -r .\backend\requirements.txt
$env:PYTHONPATH = "$PWD\backend"
$env:APP_CONFIG_PATH = "$PWD\data\config.yml"
uvicorn app.main:app --host 127.0.0.1 --port 8080 --reload

The bootstrap file must use paths that exist on the host. Point the database, data directory, and master key to absolute paths under the checkout’s ignored data directory.

Linux

bootstrap_version: 1
database:
  driver: sqlite
  path: /home/user/brokerr/data/app.db
storage:
  data_dir: /home/user/brokerr/data
security:
  master_key_file: /home/user/brokerr/data/master_key

Windows

Use forward slashes in YAML paths:

bootstrap_version: 1
database:
  driver: sqlite
  path: C:/projects/brokerr/data/app.db
storage:
  data_dir: C:/projects/brokerr/data
security:
  master_key_file: C:/projects/brokerr/data/master_key

Container paths such as /data/app.db are not automatically mapped in source mode and work only when those paths exist on the host.

Frontend

Open a second terminal while the backend is running:

Linux

cd frontend
npm install
npm run dev

Windows

Run these commands in PowerShell:

cd .\frontend
npm install
npm run dev

Open the URL printed by Vite. Requests under /api and /webhooks are proxied to http://localhost:8080.

Production build check

Linux

cd frontend
npm run build

Windows

cd .\frontend
npm run build

The production Dockerfile performs this frontend build and serves the resulting static assets from the FastAPI application.