Quick Start Guide
Get VibeCode up and running in your local environment in under 10 minutes.
Prerequisites
Section titled “Prerequisites”- Docker: Version 20.10+ with Docker Compose V2
- kubectl: Kubernetes command-line tool
- KIND: Kubernetes in Docker (for local clusters)
- Node.js: Version 18+ for the web interface
- Git: For cloning the repository
Installation
Section titled “Installation”1. Clone the Repository
Section titled “1. Clone the Repository”git clone https://github.com/vibecode/vibecode-webgui.gitcd vibecode-webgui
2. Configure Environment
Section titled “2. Configure Environment”# Copy environment templatecp claude-prompt.md .env.local
# Edit with your API keysnano .env.local
Required Environment Variables:
# Datadog (for monitoring)DD_API_KEY="your-datadog-api-key" # falls back to DATADOG_API_KEY if set
# AI IntegrationOPENROUTER_API_KEY="your-openrouter-key"CLAUDE_API_KEY="your-claude-key"
# DatabaseDATABASE_URL="postgresql://username:password@localhost:5432/vibecode_dev"
3. Create Local Cluster
Section titled “3. Create Local Cluster”# Create KIND cluster with monitoring./scripts/setup-kind-cluster.sh
# Verify cluster is runningkubectl cluster-info --context kind-vibecode-cluster
4. Deploy Monitoring Stack
Section titled “4. Deploy Monitoring Stack”# Source environment variablessource .env.local
# Deploy hybrid monitoring (Datadog + Prometheus + Vector)./scripts/deploy-monitoring.sh -m kubernetes -d "${DD_API_KEY:-$DATADOG_API_KEY}"
5. Start the Application
Section titled “5. Start the Application”# Install dependenciesnpm install
# Start development servernpm run dev
Verification
Section titled “Verification”Check Cluster Status
Section titled “Check Cluster Status”# View all podskubectl get pods -A
# Check monitoring namespacekubectl get pods -n vibecode-monitoring
Access Interfaces
Section titled “Access Interfaces”- VibeCode UI: http://localhost:3000
- Prometheus: http://localhost:9090 (via port-forward)
- Grafana: http://localhost:3001 (via port-forward)
- Datadog: https://app.datadoghq.com/
Test AI Integration
Section titled “Test AI Integration”- Navigate to http://localhost:3000
- Go to the AI Project Generator
- Enter a prompt like: “Create a React todo app with TypeScript”
- Watch as the AI generates a complete project structure
Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”Docker Compose not found:
# Check Docker Compose versiondocker compose version
# If using old version, install Docker Compose V2
KIND cluster creation fails:
# Check Docker is runningdocker info
# Remove existing cluster and retrykind delete cluster --name vibecode-cluster./scripts/setup-kind-cluster.sh
Monitoring pods not starting:
# Check node resourceskubectl top nodes
# Verify Datadog API keycurl -X GET "https://api.datadoghq.com/api/v1/validate" \ -H "DD-API-KEY: ${DD_API_KEY:-$DATADOG_API_KEY}"
Getting Help
Section titled “Getting Help”- Documentation: Browse this documentation site
- GitHub Issues: https://github.com/vibecode/vibecode-webgui/issues
- Community: Join our discussions on GitHub
Next Steps
Section titled “Next Steps”- Architecture Overview - Understand the system design
- Monitoring Setup - Configure observability
- Azure Deployment - Deploy to production
- Contributing - Join the development