Skip to main content

Quick Start Guide

Get up and running with the Sprout platform in minutes.

Prerequisites Check​

Before starting, ensure you have:

  • ✅ Node.js 18+ installed
  • ✅ Bun installed
  • ✅ Docker installed and running
  • ✅ Doppler CLI installed and authenticated

Step 1: Clone and Setup Doppler​

# Navigate to sprout directory
cd /Users/stef/apps/sprout

# Setup Doppler (if not already done)
doppler setup

Step 2: Start Docker Services​

# Start PostgreSQL and Redis
cd sprout_backend
docker-compose up -d

# Verify services are running
docker ps

Step 3: Install Dependencies​

# Backend
cd sprout_backend
bun install

# ETL Service
cd ../sprout_etl
bun install

# Frontend Dashboard
cd ../pricing_dashboard
bun install

Step 4: Setup Database​

# Run migrations for backend
cd sprout_backend
doppler run -- npx prisma migrate dev

# Run migrations for ETL (if separate database)
cd ../sprout_etl
doppler run -- npx prisma migrate dev

Step 5: Start Services​

Terminal 1: Backend API​

cd sprout_backend
doppler run -- bun run start:dev

Terminal 2: Backend Worker​

cd sprout_backend
doppler run -- bun run worker:dev

Terminal 3: ETL Service​

cd sprout_etl
doppler run -- bun run start:dev

Terminal 4: Frontend Dashboard​

cd pricing_dashboard
bun run dev

Step 6: Verify Services​

Common Issues​

Port Already in Use​

# Find what's using the port
lsof -i :3000

# Kill the process or change the port

Database Connection Failed​

# Check Docker containers
docker ps

# Check database URL in Doppler
doppler secrets get DATABASE_URL

Missing Environment Variables​

All required variables should be in Doppler. Check the service's config file:

  • sprout_backend/src/config.ts
  • sprout_etl/src/config.ts

Next Steps​

Minimum Viable Setup​

If you only need to work on one service:

  1. For Backend Development:

    cd sprout_backend
    docker-compose up -d
    bun install
    doppler run -- npx prisma migrate dev
    doppler run -- bun run start:dev

  2. For Frontend Development:

    cd pricing_dashboard
    bun install
    bun run dev

  3. For ETL Development:

    cd sprout_etl
    docker-compose up -d
    bun install
    doppler run -- npx prisma migrate dev
    doppler run -- bun run start:dev

Getting Help​