How denquinmaxence/brief--apimairie works
Project type and purpose
• This is a RESTful backend API (“Brief Api-Mairie”) written in Node.js + Express, using MongoDB as its data store.
• Its purpose is to allow authenticated users (and admins) to register/login, manage users and roles, define report categories, submit reports (with optional image uploads), and notify via email.
File structure
• Top-level: server.js (app entrypoint), package.json, Procfile (Heroku deploy), .env.example
• config/: DB connection (config/db.js) and initialization (config/init.js)
• routes/: express.Router definitions for each resource (/auth, /users, /roles, /reports, /reports/category)
• controllers/: handler functions implementing business logic for each route
• middleware/: authentication (isAuthenticated, isAdmin), request-body validation (checkBody*), file upload & Cloudinary integration, global index.js aggregator
• models/: Mongoose schemas for User, Role, ReportCategory, Report
• utils/: Multer setup (multipart parsing), email sending (sendEmail), generic validators (isValid)
Key insights from the README
• Standard CRUD endpoints per resource
• Authentication via JWT (login, logout, protected routes)
• File uploads stored on Cloudinary
• Email notifications sent on report creation
• Hosted on Heroku behind a Procfile
a. Main components
• Client (future UI or third-party consumers)
• HTTP(S) Load Balancer / API Gateway (Heroku Router)
• Express Application
– Routes Layer
– Middleware Pipeline
– Controllers (AuthController, UserController, RoleController, ReportController, ReportCategoryController)
– Utils (Multer, sendEmail)
• Data Layer
– MongoDB (Atlas or self-hosted)
– Cloudinary (image storage)
– SMTP/Email Service (e.g., Outlook, SendGrid)
• Configuration/Secrets (dotenv, .env)
b. Relationships and data flow
1. Client → HTTP(S) → Load Balancer → Express Routes
2. Routes → Validation & Auth Middleware
3. On file-upload routes: Multer parses multipart → Cloudinary middleware uploads image → Controller
4. Controller → Mongoose Model → MongoDB
5. On report creation: Controller → sendEmail util → External Email Service
6. Controller → Response → Client
c. Architectural patterns & design principles
• Layered MVC-inspired structure (Routes → Controllers → Models)
• Middleware chain for cross-cutting concerns (auth, validation, file handling)
• Single monolithic service hosted on Heroku
• Environment-driven configuration (12-factor app)
• Separation of concerns: controllers hold business logic, utils handle integrations
d. Key technologies
• Node.js + Express
• MongoDB + Mongoose
• JWT for authentication
• Multer & Cloudinary for file storage
• SMTP/External email for notifications
• dotenv for config, Heroku Procfile for deployment
Essential details to capture
• The JWT authentication flow (login endpoint issues token, protected endpoints require token via authMiddleware)
• Role‐based access control (isAdmin middleware guarding admin routes)
• File upload sequence (Multer → cloudinary.js middleware → ReportController)
• Email notification path (ReportController → utils/sendEmail → SMTP service)
• Database interaction (each controller calls corresponding Mongoose model)