Skip to content

Getting started

Keanan runs entirely from one Docker Compose file. This guide takes you from a clean checkout to a working stack with seeded demo data.

Keanan’s source is private. Everything below assumes the repository access that comes with your license.

You need Docker with the Compose plugin, and Flutter with FVM if you plan to run the mobile app. Nothing else is required. Postgres, Redis and Unleash all run inside the stack.

Terminal window
cd backend
docker compose up -d
docker compose exec web python manage.py migrate
docker compose exec web python manage.py seed

The seed command prints its demo credentials in the terminal when it finishes. They exist for local evaluation only. Production deployments skip the seed step and create their admin account with createsuperuser.

Service Address
API http://localhost:8000
Admin dashboard http://localhost:5173
API documentation http://localhost:8000/api/docs
Unleash console http://localhost:4242
Terminal window
fvm flutter run

The app targets the local API on the iOS simulator and the Android emulator without configuration. Sign in with any seeded account.

Open http://localhost:8000/api/docs to confirm the API is serving its interactive reference, then sign in to the dashboard with a seeded account. If both work, the stack is healthy.