How slantie/reflectify-backend works
Project type and purpose
• Reflectify is a Node.js/TypeScript monolithic backend API for managing feedback in educational institutions.
• It exposes REST endpoints under /api/v1 for academic structures, authentication, feedback forms, analytics, email queuing, and uploads.
• Key features: role-based JWT auth, service-to-service API keys, Prisma ORM with PostgreSQL, Redis+BullMQ email queue, Gmail SMTP fallback, Zod validation, and rate limiting.
File structure
• src/api/v1/routes → Express route definitions, organized by resource (auth, academicYear, feedbackForm, analytics, etc.)
• src/controllers/* → HTTP handlers invoking business logic
• src/services/* → Core application logic, database access via PrismaService plus integrations (email queue, Redis, SMTP)
• src/middlewares → Authentication (JWT and service-API-key), error handling, request validation
• src/utils → Shared utilities (error wrapper, async handler, JWT helper, hashing, templates, scheduler, validators)
• prisma/schema.prisma → Data model for PostgreSQL, including OverrideStudent replacing legacy Student
• Config folder → Environment and CORS settings
• Build/deploy files: tsconfig.json, package.json, .env.example, server.ts
README for additional insights
• Critical change: all student data now uses OverrideStudent model
• Email queue: Redis + BullMQ, rate-limit 1 mail/4s, 5 retries, fallback SMTP
• Auth: JWT for admins/faculty, token for student submissions, API-key for internal services
• External dependencies: PostgreSQL, Redis, Gmail SMTP
• Security: Helmet, CORS, Zod validation, Prisma (SQL injection protection), rate limiting