- Complete monorepo structure with pnpm workspaces - Prisma database schema with 20+ entities - NestJS API with 9 core modules - BullMQ orchestration worker - AWS and Azure provider adapters - Docker Compose infrastructure - Complete documentation
1.7 KiB
1.7 KiB
SDI SaaS Platform - Quick Start Guide
Local Development Setup
1. Install Dependencies
pnpm install
2. Start Infrastructure
docker-compose up -d postgres redis
3. Configure Environment
# Copy environment files
cp apps/api/.env.example apps/api/.env
cp apps/worker/.env.example apps/worker/.env
cp packages/database/.env.example packages/database/.env
4. Initialize Database
# Generate Prisma client
pnpm db:generate
# Run migrations
pnpm db:migrate
5. Seed Sample Data (Optional)
Create a seed script to populate initial data:
# TODO: Create seed script
# pnpm db:seed
6. Start Development Servers
# Terminal 1: API Server
pnpm --filter @sdi/api dev
# Terminal 2: Worker
pnpm --filter @sdi/worker dev
7. Access Services
- API: http://localhost:3000
- API Docs: http://localhost:3000/api/docs
- Database Studio:
pnpm db:studio
Testing the API
Create a Tenant
curl -X POST http://localhost:3000/api/v1/tenants \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corporation",
"slug": "acme-corp"
}'
List Providers
curl http://localhost:3000/api/v1/providers
Create a Quote
curl -X POST http://localhost:3000/api/v1/quotes \
-H "Content-Type: application/json" \
-d '{
"productOfferingId": "uuid-here",
"sourceEndpointId": "uuid-here",
"targetEndpointId": "uuid-here",
"bandwidthMbps": 1000
}'
Next Steps
- Implement authentication (JWT/OAuth)
- Add seed data for providers and endpoints
- Build customer portal (Vue 3)
- Complete AWS/Azure adapter implementations
- Add real-time updates via SSE