chore(dev-env): add local docker-compose, Makefile, env templates & docs

Author: safichaudhry

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install black
+          
+      - name: Check formatting
+        run: make fmt 

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+    -   id: black
+        language_version: python3
+        types: [python]
+
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        args: ["--profile", "black"]
+        types: [python] 

Makefile

@@ -0,0 +1,18 @@
+.PHONY: setup up down migrate fmt
+
+setup:  ## one-time env + DB prep
+	cp -n backend/.env.template backend/.env || true
+	cp -n frontend/.env.local.template frontend/.env.local || true
+	./scripts/supa_migrate.sh
+
+up:     ## run stack
+	docker compose -f docker-compose.local.yaml up --build
+
+down:   ## stop & clean
+	docker compose -f docker-compose.local.yaml down -v
+
+migrate: ## rerun Supabase migration
+	./scripts/supa_migrate.sh
+
+fmt:    ## auto-format backend python
+	black backend 

README.md

@@ -18,6 +18,22 @@ Suna's powerful toolkit includes seamless browser automation to navigate the web
 )](https://github.com/kortix-ai/suna/labels/bug)
 </div>
 
+## 🚀 Quick start (local)
+
+```bash
+git clone https://github.com/<YOUR_GH_USERNAME>/suna.git && cd suna
+make setup && make up
+# browse http://localhost:3000
+```
+
+Before running, make sure to:
+1. Create a [Supabase](https://supabase.com) project and get your API credentials
+2. Get an API key from [Anthropic](https://www.anthropic.com)
+3. Set up a sandbox on [Daytona](https://daytona.io)
+
+Fill these credentials in your `.env` files after running `make setup`.
+
+For code contributors: Install pre-commit hooks with `pip install pre-commit && pre-commit install`
 
 ## Table of Contents
 

backend/.env.template

@@ -0,0 +1,46 @@
+# Environment mode (local, staging, production)
+ENV_MODE=local
+
+# LLM API keys
+ANTHROPIC_API_KEY=
+OPENAI_API_KEY=
+GROQ_API_KEY=
+OPENROUTER_API_KEY=
+OPENROUTER_API_BASE=https://openrouter.ai/api/v1
+OR_SITE_URL=
+OR_APP_NAME=Suna.so
+
+# AWS Bedrock credentials
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION_NAME=
+
+# Model configuration
+MODEL_TO_USE=anthropic/claude-3-7-sonnet-latest
+
+# Supabase configuration
+SUPABASE_URL=
+SUPABASE_ANON_KEY=
+SUPABASE_SERVICE_ROLE_KEY=
+
+# Redis configuration (for local development)
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_PASSWORD=
+REDIS_SSL=false
+
+# Daytona sandbox configuration
+DAYTONA_API_KEY=
+DAYTONA_SERVER_URL=
+DAYTONA_TARGET=
+
+# Search and other API keys
+TAVILY_API_KEY=
+RAPID_API_KEY=
+CLOUDFLARE_API_TOKEN=
+FIRECRAWL_API_KEY=
+
+# Stripe configuration
+STRIPE_SECRET_KEY=
+STRIPE_DEFAULT_PLAN_ID=
+STRIPE_DEFAULT_TRIAL_DAYS=14 

docker-compose.local.yaml

@@ -0,0 +1,49 @@
+version: '3.8'
+
+services:
+  backend:
+    build:
+      context: ./backend
+      dockerfile: Dockerfile
+    ports:
+      - "8000:8000"
+    volumes:
+      - ./backend:/app
+    env_file:
+      - ./backend/.env
+    depends_on:
+      - redis
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+
+  frontend:
+    build:
+      context: ./frontend
+      dockerfile: Dockerfile
+    ports:
+      - "3000:3000"
+    volumes:
+      - ./frontend:/app
+      - /app/node_modules
+    env_file:
+      - ./frontend/.env.local
+    depends_on:
+      - backend
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3000"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 30s
+      timeout: 10s
+      retries: 3 

frontend/.env.local.template

@@ -0,0 +1,6 @@
+# Supabase configuration
+NEXT_PUBLIC_SUPABASE_URL=
+NEXT_PUBLIC_SUPABASE_ANON_KEY=
+
+# Backend URL
+NEXT_PUBLIC_BACKEND_URL=http://localhost:8000 

scripts/supa_migrate.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Check if supabase CLI is installed
+if ! command -v supabase &> /dev/null; then
+    echo "❌ Error: supabase CLI is not installed"
+    echo "Please install it from: https://supabase.com/docs/guides/cli"
+    exit 1
+fi
+
+# Run migration
+echo "🔄 Running Supabase migration..."
+supabase db push
+
+# Check if migration was successful
+if [ $? -eq 0 ]; then
+    echo "✅ DB migrated"
+else
+    echo "❌ Migration failed"
+    exit 1
+fi