Add README and technical docs

- README with quick start, package overview, links to docs
- docs/setup.md — prerequisites, env vars, installation, running, testing
- docs/architecture.md — monorepo structure, backend/frontend design
- docs/api.md — full endpoint reference with permissions
- docs/database.md — schema overview, migrations, multi-tenancy
- docs/testing.md — test runner, suites, writing tests
- Updated .env.example with all supported variables
This commit is contained in:
Ryan Moon
2026-03-29 08:31:20 -05:00
parent b9f78639e2
commit 1d48f0befa
7 changed files with 599 additions and 7 deletions

View File

@@ -1,13 +1,14 @@
# Forte — Development Environment Variables
# These are used inside Docker Compose (docker-compose.dev.yml overrides most of these)
# Forte — Environment Variables
# Copy to .env and adjust values for your setup.
# Docker Compose overrides host values (postgres, valkey) automatically.
# Database
DATABASE_URL=postgresql://forte:forte@postgres:5432/forte
# Database (PostgreSQL 16)
DATABASE_URL=postgresql://forte:forte@localhost:5432/forte
# Valkey (Redis-compatible)
REDIS_URL=redis://valkey:6379
# Valkey / Redis
REDIS_URL=redis://localhost:6379
# JWT
# JWT — use a strong random secret in production
JWT_SECRET=change-me-in-production-use-a-long-random-string
# API Server
@@ -16,3 +17,17 @@ HOST=0.0.0.0
# Environment
NODE_ENV=development
# Logging (optional)
# LOG_LEVEL=info
# LOG_FILE=./logs/forte.log
# File Storage (optional — defaults to local)
# STORAGE_PROVIDER=local
# STORAGE_LOCAL_PATH=./data/files
# CORS (optional — defaults to * in development)
# CORS_ORIGINS=https://admin.example.com
# Frontend URL (used in password reset links)
# APP_URL=http://localhost:5173