A new README for the combined project with setup from the Flashpoint Ultimate torrent. New feature docs for streaming, proxy sign-in and game saves; deployment, upgrade and streaming READMEs updated for the single compose file; the project renamed throughout.
5.3 KiB
5.3 KiB
Commands Reference
All npm commands available in Dotcom Arcade monorepo.
Monorepo Commands
Run from repository root.
Development
npm run dev # Start all services (concurrent)
npm run dev:backend # Backend only
npm run dev:frontend # Frontend only
Installation
npm run install:all # Install all service dependencies
npm run install:backend # Backend only
npm run install:frontend # Frontend only
Building
npm run build # Build all services for production
npm run build:backend
npm run build:frontend
Type Checking
npm run typecheck # Type check all services
npm run typecheck:backend
npm run typecheck:frontend
Production
npm start # Start backend in production
npm run start:backend
Code Formatting
npm run format # Format all files with Prettier
npm run format:check # Check without changes
npm run format:backend
npm run format:frontend
Cleanup
npm run clean # Remove all build artifacts + node_modules
npm run clean:backend
npm run clean:frontend
Backend Commands
Run from backend/ directory.
Development
npm run dev # Start with hot reload
npm run kill-port # Kill process on port 3100 (Windows)
Building & Production
npm run build # Compile TypeScript to dist/
npm start # Run production build
Code Quality
npm run typecheck # Type check only
npm run lint # Check code with ESLint
npm run lint -- --fix # Auto-fix issues
Testing
npm test # Run all tests
npm test -- --watch # Watch mode
npm test -- --coverage # With coverage report
npm test src/services/GameService.test.ts # Specific file
npm test -- --grep "pattern" # Pattern matching
Frontend Commands
Run from frontend/ directory.
Development
npm run dev # Start Vite dev server (http://localhost:5173)
Building & Preview
npm run build # Build for production (frontend/dist/)
npm run preview # Preview production build locally (http://localhost:4173)
Code Quality
npm run typecheck # Type check only
npm run lint # Check code with ESLint
npm run lint -- --fix # Auto-fix issues
Utilities
npm run copy-ruffle # Copy Ruffle emulator to public/ruffle/
Docker Commands
Run from repository root.
Building
docker-compose build # Build all services
docker-compose build backend # Specific service
docker-compose build --no-cache # Clean build
Running
docker-compose up -d # Start all (background)
docker-compose up # Start all (foreground)
docker-compose up -d backend # Start specific service
docker-compose up -d --build # Rebuild and restart
Monitoring & Management
docker-compose logs -f # View all logs
docker-compose logs -f backend # Specific service
docker-compose ps # List running containers
docker-compose stop # Stop all
docker-compose down # Stop and remove
docker-compose down -v --rmi all # Full cleanup
docker-compose restart backend # Restart specific service
docker-compose exec backend npm test # Run command in container
Prerequisites
# Set Flashpoint path before running Docker
export FLASHPOINT_HOST_PATH=/path/to/Flashpoint
# Windows PowerShell
$env:FLASHPOINT_HOST_PATH = "D:\Flashpoint"
Common Workflows
First Time Setup
npm run install:all
cp backend/.env.example backend/.env
# Edit .env with Flashpoint path
npm run typecheck
npm run dev
Before Committing
npm run typecheck
cd backend && npm run lint && npm test
npm run build
Debugging Build Issues
npm run clean
npm run install:all
npm run typecheck
npm run build
Production Deployment
npm run build
export NODE_ENV=production
npm start
Environment Variables
Backend (.env)
| Variable | Required | Default | Notes |
|---|---|---|---|
FLASHPOINT_PATH |
Yes | - | All other paths derived automatically |
JWT_SECRET |
Yes* | - | *Required in production |
DOMAIN |
No | http://localhost:5173 | Frontend URL for CORS |
LOG_LEVEL |
No | info | error, warn, info, debug |
NODE_ENV |
No | development | production in production |
Note: External fallback URLs are configured in
proxySettings.json.
Frontend
No environment variables required for local development. In production, Nginx proxies to backend.