Docker (Local Development)

Get Fluxgate running locally in under 5 minutes with Docker Compose.

Requirements

Docker Desktop (with Docker Compose v2)
Git
4GB+ available RAM
10GB+ free disk space

Setup Steps

Clone the Repository

Download the Fluxgate source code.

git clone https://github.com/Anil175/fluxgate.git
cd fluxgate

Configure Environment

Copy the example env file. Defaults work for local development.

cp .env.example .env

Start All Services

Launch all 12 containers. First run downloads images (3-5 minutes).

docker compose up -d

Verify Services

Check all containers are running.

docker compose ps

Run Migrations

Create database tables.

docker compose exec api python -m shared.migrations.run

Seed Data

Create default roles, permissions, and starter API key.

docker compose exec api python seed.py

Running Services

Service	Port	URL
Dashboard	3000	http://localhost:3000
API	8000	http://localhost:8000
Gateway	8080	http://localhost:8080
Swagger UI	8000	http://localhost:8000/docs
TimescaleDB	5432	localhost:5432
Redis	6379	localhost:6379
Kafka	9092	localhost:9092

Common Commands

Useful Commandsbash

# View logs for a specific service
docker compose logs -f api

# Restart a single service
docker compose restart api

# Stop everything
docker compose down

# Stop and remove all data (fresh start)
docker compose down -v

Hot Reload

The API and Dashboard containers support hot reload. Code changes are reflected automatically without restarting.

Deployment Overview

Docker (Production)