Getting Started

Follow these steps to deploy and run the BurstDB Synthesis Platform in your development environment.

🏗️ Prerequisites

Ensure your system meets the following infrastructure requirements:

• Python 3.13+ — Core API & ML workers
• Node.js 18+ — UI Interface
• uv — High-performance Python package manager (Recommended)
• Redis 6.0+ — Distributed task broker

1. Environment Orchestration

Clone the platform and navigate to the root directory:

git clone https://github.com/ghoshsoham71/BurstDB.git
cd BurstDB

2. Infrastructure Setup (Backend)

The backend requires two parallel processes: the API Gateway and the Synthesis Worker.

API Gateway

cd api
uv sync
uv run uvicorn main:app --reload --port 8000

Synthesis Worker

# In a new terminal process
cd api
uv run celery -A src.celery_app worker --loglevel=info -P solo

3. Interface Setup (Frontend)

Run the Next.js environment to access the Studio and Dashboard:

cd ui
npm install
npm run dev

The platform will be available at http://localhost:3000 .

4. Environment Configuration

Create a .env file in the api/ directory for secure integrations:

# Required for persistent storage
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key

# Broker Configuration
REDIS_URL=redis://localhost:6379/0

📡 Verification

Verify your installation by accessing the following health endpoints:

• Synthesis UI: http://localhost:3000 
• API Specs: http://localhost:8000/docs 
• Worker Status: Check the Celery terminal for worker: Ready signal.