API RESTful para la red social comunitaria TribeHub, construida con NestJS y TypeScript.
| Capa | Tecnología |
|---|---|
| Framework | NestJS |
| Lenguaje | TypeScript |
| Base de datos | PostgreSQL (Prisma ORM) |
| Autenticación | Supabase Auth + JWT |
| Cola de trabajos | BullMQ + Redis |
| Métricas | Prometheus (prom-client) |
| Error tracking | Sentry |
| Validación | class-validator + class-transformer |
| Tests | Vitest |
| Deploy | Railway |
| Módulo | Descripción |
|---|---|
AuthModule |
Registro y login via Supabase Auth |
HealthModule |
GET /api/v1/health — liveness check |
ObservabilityModule |
Métricas Prometheus, requestId middleware, LoggingInterceptor, Sentry |
SystemConfigModule |
Feature flags en base de datos con caché Redis |
QueuesModule |
Colas BullMQ con reintentos, worker y alertas a Discord |
BullboardModule |
Panel de administración de colas en /admin/queues |
- Node.js >= 20.x
- pnpm >= 9.x
- Redis (local via Docker o Railway en cloud)
- Cuenta de Supabase con proyecto configurado
git clone https://github.com/CodeCrafters-ES/tribehub-social_network-backend.git
cd tribehub-social_network-backend
pnpm installCopia el archivo de entorno:
cp .env.example .env.developmentEdita .env.development con tus credenciales (ver sección Variables de entorno).
Aplica las migraciones de base de datos:
npx prisma migrate devSin este paso la app arranca pero todas las queries a la base de datos fallan.
# Redis local (requiere Docker)
docker run -d --name redis-tribehub -p 6379:6379 redis:alpine
# Servidor con auto-reload
pnpm run start:devLa API estará disponible en http://localhost:3000/api/v1.
| Variable | Descripción | Requerida |
|---|---|---|
PORT |
Puerto del servidor (default: 3000) | No |
NODE_ENV |
development / staging / production |
Sí |
CORS_ORIGINS |
Orígenes CORS permitidos (separados por coma) | Sí |
SUPABASE_URL |
URL del proyecto Supabase | Sí |
SUPABASE_ANON_KEY |
Clave anon de Supabase | Sí |
SUPABASE_SERVICE_ROLE_KEY |
Clave service role de Supabase | Sí |
SUPABASE_JWT_SECRET |
JWT secret de Supabase (para validar tokens) | Sí |
JWT_SECRET |
Secreto JWT interno | Sí |
DATABASE_URL |
URL de conexión PostgreSQL | Sí |
REDIS_URL |
URL de conexión Redis | Sí |
REDIS_TLS |
true para habilitar TLS (Railway/producción) |
No |
SYSTEM_CONFIG_CACHE_TTL_SECONDS |
TTL en segundos para la caché de feature flags en memoria (default: 60) | No |
FRONTEND_URL |
URL del frontend (redirecciones y CORS) | Sí |
SENTRY_DSN |
DSN de Sentry (si no se define, Sentry se deshabilita) | No |
METRICS_USER |
Usuario Basic Auth para endpoint de métricas | Sí |
METRICS_PASS |
Contraseña Basic Auth para endpoint de métricas | Sí |
METRICS_PATH_SECRET |
Segmento secreto del path de métricas | Sí |
DISCORD_WEBHOOK_CRITICAL |
Webhook Discord canal #alerts-critical |
No |
DISCORD_WEBHOOK_OPS |
Webhook Discord canal #alerts-ops |
No |
QUEUE_ALERT_WAITING_THRESHOLD |
Umbral jobs en espera para alerta (default: 50) | No |
QUEUE_ALERT_FAILED_THRESHOLD |
Umbral jobs fallidos para alerta (default: 20) | No |
QUEUE_MONITOR_INTERVAL_MS |
Intervalo de polling de métricas de cola (default: 60000) | No |
SMOKE_BASE_URL |
URL base para smoke tests | No |
SMOKE_USER_EMAIL |
Email del usuario de smoke tests | No |
SMOKE_USER_PASSWORD |
Contraseña del usuario de smoke tests | No |
pnpm run start:dev # Servidor de desarrollo con auto-reload
pnpm run start:debug # Modo debug con auto-reload
pnpm run build # Compilar a dist/
pnpm run start:prod # Ejecutar build compilado
pnpm run test # Tests unitarios
pnpm run test:watch # Tests en modo watch
pnpm run test:cov # Tests con reporte de cobertura
pnpm run test:e2e # Tests end-to-end
pnpm run test:smoke # Smoke tests
pnpm run lint # ESLint con auto-fix
pnpm run format # Prettier
pnpm run lint:api # Validar OpenAPI spec con Spectral| Método | Endpoint | Descripción | Auth |
|---|---|---|---|
| GET | /api/v1/health |
Liveness check | No |
| POST | /api/v1/auth/register |
Registro de usuario | No |
| POST | /api/v1/auth/login |
Login | No |
| POST | /api/v1/auth/logout |
Logout | Bearer |
| GET | /admin/queues |
Panel BullBoard | Bearer + rol admin |
src/
auth/ # Módulo de autenticación (Supabase)
dto/
guards/
repositories/
common/ # Utilidades compartidas
filters/ # SentryExceptionFilter
guards/ # JwtAdminGuard
interceptors/ # LoggingInterceptor, HttpMetricsInterceptor
middleware/ # RequestIdMiddleware, MetricsAuthMiddleware
config/ # supabase.config.ts
health/ # HealthModule — GET /health
modules/
system-config/ # Feature flags con caché Redis
users/ # UsersModule (scaffold)
observability/
metrics/ # MetricsService, MetricsController
prisma/ # PrismaService
admin/
queues/ # BullboardModule
queues/ # QueuesModule, DefaultWorker
alerts/ # DiscordAlertService, QueueMonitorService
instrument.ts # Inicialización de Sentry
main.ts
test/
smoke/ # Smoke tests staging y producción
docs/
openapi/openapi.yaml # Spec OpenAPI (validado con Spectral en CI)
observability.md # Guía de métricas y requestId
- Observabilidad — métricas, requestId, BullBoard
- OpenAPI spec — contrato de la API
- Guía de contribución
- NestJS docs
MIT © 2025 CodeCrafters-ES