How sxxrya666/tour-management-system works
Project Type & Purpose
• This is a backend‐focused web API (built with Node.js/Express) that powers a tour management frontend (not in this repo) and stores data in MongoDB.
• Purpose: Expose RESTful endpoints for tours, users, and reviews; secure those endpoints; and run in Docker.
Key Architectural Patterns
• MVC‐style separation:
• Routes → Controllers → Models
• Middleware pipeline for cross‐cutting concerns (security, rate limiting, error handling).
• Single monolithic service (Node/Express) with a single MongoDB database.
• Containerized deployment via Docker Compose.
Main Components
A. Clients
• Web or Mobile App (HTTP(S) client)
• Optional: Admin Dashboard
B. API Service
1. API Gateway (Express app entry points: app.js/server.js)
2. Middleware Layer
• Security (helmet, hpp, data sanitization)
• Rate limiter (globalRateLimit.js)
• Body parser, compression
• Error handlers (catchErrorsInEveryRoute, AppError)
3. Routing Layer
• /api/v1/tours → tour.routes.js
• /api/v1/users → user.routes.js
• /api/v1/reviews → review.routes.js
4. Controller Layer
• tour.controller.js, user.controller.js, review.controller.js, auth.controller.js, error.controller.js
5. Business Logic & Utilities
• APIfeatures (filtering/pagination)
• token.emailer, serverShutdown, dev‐data import
6. Data Access Layer (Models)
• tourModel.js, userModel.js, reviewModel.js (Mongoose schemas)
C. Database
• MongoDB instance (hosted or containerized)
D. Infrastructure/Deployment
• Docker (Dockerfile, Dockerfile.dev)
• Docker Compose (api service + mongo service)
• Environment variables (.env)
1. Client → API Gateway (HTTP request)
2. Gateway → Middleware (sequential pipeline)
3. Middleware → Router → Controller
4. Controller ↔ Model (CRUD ops on MongoDB)
5. Controller → Utilities (e.g., send email, import data)
6. Service → Database (MongoDB)
• Error flows: Controller → Error Handler → Client (error response)
Technologies & Patterns
• Express.js for HTTP
• Mongoose for data models
• Docker Compose for orchestration
• JWT for auth (handled in auth.controller.js)
• Rate limiting, helmet, hpp, compression as middleware
• MVC organization with clear layers