3dc8592b83
- Added multi-platform deployment architecture details (Web App, PWA, DApp) to README.md. - Included comprehensive troubleshooting guides and fix scripts in README.md. - Enhanced CHANGELOG.md with new features, fixes, and improvements, including TypeScript error resolutions and updated documentation structure. - Revised development setup instructions in DEV_SETUP.md to reflect changes in script usage and environment variable setup.
1.7 KiB
1.7 KiB
Development Setup Guide
Quick Start
Option 1: Run Individual Services
Webapp (Frontend):
cd webapp
npm run dev
Access at: http://localhost:3000
Orchestrator (Backend):
cd orchestrator
npm run dev
Access at: http://localhost:8080
Option 2: Docker Compose (Full Stack)
docker-compose up -d
This starts:
- PostgreSQL (port 5432)
- Redis (port 6379)
- Orchestrator (port 8080)
- Webapp (port 3000)
Option 3: Bash Script (WSL/Ubuntu)
./scripts/start-dev.sh
Starts both services in background. See WSL Setup Guide for setup instructions.
Prerequisites
- Node.js 18+ installed
- npm installed
- PostgreSQL (optional, for local DB)
- Redis (optional, for caching)
Environment Variables
Webapp (.env.local)
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-secret
NEXT_PUBLIC_ORCH_URL=http://localhost:8080
Orchestrator (.env)
PORT=8080
DATABASE_URL=postgresql://user:pass@localhost:5432/comboflow
REDIS_URL=redis://localhost:6379
First Time Setup
- Install dependencies:
cd webapp && npm install
cd ../orchestrator && npm install
- Set up database (if using PostgreSQL):
cd orchestrator
npm run migrate
- Start services:
# Terminal 1
cd webapp && npm run dev
# Terminal 2
cd orchestrator && npm run dev
Access Points
- Webapp: http://localhost:3000
- Orchestrator API: http://localhost:8080
- Health Check: http://localhost:8080/health
- API Docs: http://localhost:8080/api-docs (if configured)
Last Updated: 2025-01-15