docs

Getting Started

Run the backend, iOS app, and web apps locally.

The four apps are independent — you don't need all of them running to work on one. Pick the tab(s) you need.

backend/ and ios/truelable/ are git submodules

Both live in their own repos (true-label-backend, true-label-ios) — a plain git clone leaves both empty. Clone with git clone --recurse-submodules <repo>, or if you already cloned plainly, git submodule update --init --recursive. Changing code in either means committing in that submodule's own repo first, then committing the updated pointer here (git add backend && git commit). web/, k8s/, infra/, and deploy/ are ordinary directories in this repo, not submodules.

Prerequisites: Rust (stable, rustup default stable), Docker (or native Postgres 17 + Redis 7).

Start Postgres and Redis. From the repo root:

docker compose up -d postgres redis

Configure environment. From backend/:

cp .env.example .env

The defaults work with the compose services above as-is. See Environment Variables for what each one does — TRUSTED_PROXY_HOPS and ALLOWED_ORIGINS matter once this runs behind a real reverse proxy, not for local dev.

Run it. Migrations run automatically on boot — there's no separate migrate step for local dev.

cd backend
cargo run

Verify.

curl http://localhost:8080/health/ready

Run the test suite with cargo test from backend/.

Repo layout at a glance

true-lable/
├── backend/     Rust (Axum) API — submodule, see /docs/backend
├── ios/         SwiftUI app — ios/truelable/ is a submodule, see /docs/ios
├── web/         Turborepo (bun) — apps/web, apps/docs, apps/dashboard, packages/ui
│                see /docs/web and /docs/dashboard
├── k8s/, infra/digitalocean/  Kubernetes deployment (DOKS) — see /docs/deployment
├── deploy/      Single-VM deployment (EC2 or a DO droplet) — the low-cost alternative
└── docker-compose.yml   Postgres + Redis for local backend dev

On this page