Quickstart – Run the platform locally

Get the full FirstBreath stack running in a few steps. For component-specific details, use the links below.

1. Clone the platform (monorepo)

git clone --recursive https://github.com/FirstBreath/FirstBreath-Platform.git
cd FirstBreath-Platform

If you already cloned without --recursive:

./setup.sh

2. Environment

Create the global environment file used by all sub-stacks:

cp .env.example .env
# Edit .env and set secure passwords (DB, Redis, etc.)

3. Start infrastructure and services

From the platform root:

docker-compose up -d --build

This starts shared infrastructure (MySQL, Redis) and the services defined in the root docker-compose.yml. Adjust according to your setup if you run backend/vision in separate repos.

4. Backend (Control Hub)

• Installation: Backend – Installation
• URL: http://localhost:3333 (default)
• Run migrations and seed: node ace migration:run then node ace db:seed (from Control-Hub-Back directory).

5. Vision (optional, requires GPU)

• Quickstart: Vision – Quickstart
• URLs: Camera Manager and Batch Inference logs; metrics on port 4002 if exposed.
• Requires NVIDIA GPU and Docker network control-hub-network (usually created by the backend stack).

6. Frontend (my-app) and Mobile

• Frontend: Run from the my-app repo (npm run dev or yarn dev). Point NEXT_PUBLIC_API_URL to your backend (e.g. http://localhost:3333).
• Mobile: Mobile – Setup. Use your machine’s LAN IP for EXPO_PUBLIC_API_URL so the device can reach the API.

Useful URLs (defaults)

Service	URL
Backend API	http://localhost:3333
Vision metrics	http://localhost:4002
RTSP streams	rtsp://localhost:8554/cam1

For deployment, see Infrastructure – Deployment.