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.
Prerequisites
Section titled “Prerequisites”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.
Start the stack
Section titled “Start the stack”cd backenddocker compose up -ddocker compose exec web python manage.py migratedocker compose exec web python manage.py seedThe 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.
Where everything lives
Section titled “Where everything lives”| Service | Address |
|---|---|
| API | http://localhost:8000 |
| Admin dashboard | http://localhost:5173 |
| API documentation | http://localhost:8000/api/docs |
| Unleash console | http://localhost:4242 |
Run the employee app
Section titled “Run the employee app”fvm flutter runThe app targets the local API on the iOS simulator and the Android emulator without configuration. Sign in with any seeded account.
Verify the install
Section titled “Verify the install”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.