Skip to main content

Getting Started

This page gets the whole platform running locally. For details on any one piece, see the Developer Guide.

Fastest path — single script​

From the repository root:

./start.sh

This builds all three frontends into fastapi-backend/public/, creates a Python venv, installs backend dependencies, and starts the backend on port 8082.

EndpointURL
Websitehttp://localhost:8082/
Admin Panelhttp://localhost:8082/admin/
Super Admin Panelhttp://localhost:8082/super-admin/
API docs (Swagger UI)http://localhost:8082/docs

Environment setup​

for d in fastapi-backend admin-panel super-admin-panel website; do
  cp $d/.env.example $d/.env
done

Key backend variables: DATABASE_URL, JWT_SECRET, BROADCAST_TOKEN, ICECAST_*, MQTT_*, EXPO_ACCESS_TOKEN, APNS_*. Full reference: Configuration.

Running pieces independently​

See Local Development for backend-only and frontend-only workflows, and Testing for the test suite.

Docker​

docker compose up --build
# or, for local development with exposed ports:
docker compose -f docker-compose.local.yml up --build

Full production topology: Deployment.