Install
Local Docker setup
Section titled “Local Docker setup”-
Clone the repository.
Terminal window git clone https://github.com/CMLPlatform/relabcd relab -
Install local tooling if you plan to modify code.
Terminal window just setup -
Create local backend secrets.
Terminal window just deploy-secrets-template devRuntime secrets live in the gitignored
secrets/dev/; replace a value there only when you need a real credential for an integration. For backend-only overrides such as OAuth, email, or the bootstrap superuser, createbackend/.env.dev:backend/.env.dev GOOGLE_OAUTH_CLIENT_ID=google-oauth-client-idGITHUB_OAUTH_CLIENT_ID=github-oauth-client-idEMAIL_PROVIDER=smtpSMTP_HOST=smtp.example.comSMTP_USERNAME=you@example.comEMAIL_FROM=Your Name <you@example.com>EMAIL_REPLY_TO=you@example.comBOOTSTRAP_SUPERUSER_EMAIL=you@example.com -
Start the database and cache, then run the migrations.
Terminal window just dev-dbjust dev-migrateTo seed sample data, run
SEED_DUMMY_DATA=true just dev-migrate. To seed the CPV or HS taxonomies too:Terminal window BACKEND_MIGRATIONS_INCLUDE_TAXONOMY_SEED_DEPS=true just dev-migrate -
Start the stack.
Terminal window just devjust dev-upstarts the stack without file watching. -
Open the local services.
- API: http://127.0.0.1:8010
- App frontend: http://127.0.0.1:8011
- Docs: http://127.0.0.1:8012
- Landing site: http://127.0.0.1:8013
-
Verify the backend is healthy.
Terminal window curl http://127.0.0.1:8010/health -
To run the checks:
Terminal window just ci
To run the stack for other people on a production or staging host, continue with Configure.
Raspberry Pi camera plugin
Section titled “Raspberry Pi camera plugin”For camera-assisted capture, install the
Raspberry Pi Camera Plugin with its
install guide. The
Pi connects outbound to the backend over a WebSocket relay, so it needs no public IP or port
forwarding. Set PAIRING_BACKEND_URL on the Pi, then pair it as the
platform camera guide describes.