widgettdc-api / docs /DEPLOYMENT.md
Kraft102's picture
fix: sql.js Docker/Alpine compatibility layer for PatternMemory and FailureMemory
5a81b95

Deployment Guide

Prerequisites

  • Node.js 18+ or 20+
  • npm 9+
  • Environment variables configured

Environment Configuration

  1. Copy .env.example to .env.local:
cp .env.example .env.local
  1. Configure required variables:
GEMINI_API_KEY=your_api_key_here
VITE_MCP_SERVER_URL=wss://your-mcp-server.com/mcp
  1. Validate configuration:
npm run build

Development Deployment

# Install dependencies
npm install --legacy-peer-deps

# Start development server
npm run dev

# Access at http://localhost:3000

Production Build

# Build for production
npm run build

# Preview production build
npm run preview

Docker Deployment

# Build image
docker build -t widgetboard:latest .

# Run container
docker run -p 3000:3000 \
  -e GEMINI_API_KEY=your_key \
  widgetboard:latest

Security Checklist

  • All environment variables configured
  • HTTPS/WSS enabled in production
  • CSP headers configured
  • Rate limiting enabled
  • Authentication configured
  • Logging enabled
  • Error monitoring configured

Monitoring

  • Health check: /health
  • Metrics: /metrics
  • Logs: Check console and storage

Troubleshooting

See TROUBLESHOOTING.md for common issues.