This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Sign in to like and favorite skills
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
This is a web-based VPN management application that integrates with Outline VPN servers. The application provides a comprehensive web interface for managing VPN access keys, users, billing system, and server administration.
The project is a full-stack web application with the following structure:
/backend/frontendThe application requires these environment variables in a
.envDATABASE_URLJWT_SECRETOUTLINE_API_URLOUTLINE_API_FINGERPRINTFor quick UI development and testing with hot reload:
# Start development environment (recommended for UI changes) ./dev.sh dev # This starts: # - Backend and database in Docker containers # - Frontend with Vite dev server (hot reload) in Docker # - Frontend available at: http://localhost:3000 # - Backend API at: http://localhost:3001/api # - Database at: localhost:5433 # Login credentials: # Admin: [email protected] / admin123 # User: [email protected] / user123
For full production builds:
# Full production build and test ./dev.sh test # - Builds all services with production Dockerfiles # - Available at: http://localhost:8080
# Backend development (manual) cd backend npm install npm run dev # Frontend development (manual) cd frontend npm install npm run dev # Database operations npx prisma migrate dev npx prisma db seed npx prisma studio
ALL USER REQUESTS MUST GO THROUGH SPECIALIZED AGENTS - NEVER WORK DIRECTLY
dev-team-coordinator - ALWAYS USE FIRST for any user request
Specialized Agents (delegated by coordinator):
Workflow:
User Request → dev-team-coordinator → Specialist Agent(s) → Complete Task
NEVER bypass this workflow - always start with dev-team-coordinator agent!
./dev.sh dev./dev.sh test# Build and push images to Docker registry ./dev.sh deploy # This builds production images and pushes them to the configured registry # Uses docker-compose.registry.yml for registry configuration
After pushing images to registry, on the production server:
# Pull latest code and Docker images git pull origin master docker compose -f docker-compose.server.yml pull docker compose -f docker-compose.server.yml up -d --force-recreate # Or use deployment script if available ./deploy.sh
./dev.sh build # Build images locally ./dev.sh up # Start local development environment ./dev.sh logs # Show logs (optionally specify service) ./dev.sh stop # Stop local environment ./dev.sh clean # Clean up all local data ./dev.sh seed # Seed database with test users ./dev.sh test # Test locally before deploying ./dev.sh deploy # Build and push to production registry
# Copy and configure environment cp .env.production .env # Edit .env with your settings # Deploy with Docker Compose ./deploy.sh # Or manual deployment docker-compose -f docker-compose.prod.yml up -d