# saad0095/hotel-management-system architecture

> Architecture diagram of the GitHub repository saad0095/hotel-management-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/saad0095/hotel-management-system
- Repository: https://github.com/saad0095/hotel-management-system

## Overview

##### Project type and purpose
- This is a backend RESTful API for a Hotel Management System, built with Node.js, Express, and MongoDB (Mongoose).
- It provides endpoints for rooms, users, bookings, services, and analytics, secured with JWT-based authentication and role-based access.

##### Main architectural layers & components
a. Client Layer (External)
- Mobile app / Web front-end / CLI / third-party integrator
- Sends HTTP(S) requests with JWT tokens

b. API Layer (Express Server)
- index.js: entry point, loads middlewares, routes, DB connection
- middlewares/:
- authMiddleware.js – JWT verification, role checks
- uploadMiddleware.js – file upload handling (e.g., profile images)
- routes/:
- Maps URL paths (/api/rooms, /api/bookings, etc.) to controllers

c. Controller Layer
- controllers/*.js
- Implements business logic: validate inputs, call models, handle errors

d. Data Access Layer (Models & DB)
- models/*.js – Mongoose schemas for User, Room, Booking, Service
- db/index.js – Initializes MongoDB connection
- seed/ – Scripts to prepopulate MongoDB with rooms, services, bookings, users

e. External Dependencies
- MongoDB (local or Atlas)
- JWT Authentication
- File storage (local / cloud for uploads/)

##### Relationships & Data Flow
1. Client → Express Server (HTTP request + Authorization header)
2. Express Router → Auth Middleware → Upload Middleware (if applicable)
3. Controller → calls Model methods
4. Model → interacts with MongoDB
5. Controller → responds to client

##### Architectural patterns & design principles
- Layered architecture: separation of concerns (routing, middleware, controllers, models)
- RESTful design: one resource per route file
- JWT-based stateless authentication & RBAC
- Single codebase monolith, prepared for horizontal scaling

##### Technologies & frameworks in each layer
- Node.js, Express
- Mongoose (MongoDB ODM)
- JWT (jsonwebtoken)
- dotenv (config)
- multer or similar for file uploads
- npm scripts for seeding data

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Clients
    Clients["Clients<br/>(Mobile/Web/CLI)"]:::external
    API_GW["API Gateway<br/>(Load Balancer)"]:::external

    %% Express Application
    subgraph "Express App"
        direction TB

        Entry["index.js<br/>(Entry Point)"]:::internal

        subgraph "Middlewares"
            direction TB
            AuthMW["authMiddleware.js"]:::internal
            UploadMW["uploadMiddleware.js"]:::internal
        end

        subgraph "Routes"
            direction TB
            RoomRoutes["roomRoutes.js<br/>(/api/rooms)"]:::internal
            BookingRoutes["bookingRoutes.js<br/>(/api/bookings)"]:::internal
            ServiceRoutes["serviceRoutes.js<br/>(/api/services)"]:::internal
            UserRoutes["userRoutes.js<br/>(/api/users)"]:::internal
            AnalyticsRoutes["analyticsRoutes.js<br/>(/api/analytics)"]:::internal
        end

        subgraph "Controllers"
            direction TB
            RoomController["roomController.js"]:::internal
            BookingController["bookingController.js"]:::internal
            ServiceController["serviceController.js"]:::internal
            UserController["userController.js"]:::internal
            AnalyticsController["analyticsController.js"]:::internal
        end

        subgraph "Models & DB Init"
            direction TB
            RoomModel["room.js"]:::internal
            BookingModel["booking.js"]:::internal
            ServiceModel["service.js"]:::internal
            UserModel["user.js"]:::internal
            DBInit["db/index.js"]:::internal
        end
    end

    %% External Services
    MongoDB["MongoDB"]:::db
    FileStorage["File Storage"]:::external
    JWTService["JWT Service<br/>(jsonwebtoken)"]:::external

    %% Seed Scripts
    subgraph "Seed Scripts"
        direction TB
        SeedRooms["seedRooms.js"]:::dashed
        SeedBookings["seedBookings.js"]:::dashed
        SeedServices["seedServices.js"]:::dashed
        SeedUsers["seedUsers.js"]:::dashed
    end

    %% Data Flow
    Clients -->|HTTP + JWT| API_GW
    API_GW --> Entry
    Entry --> AuthMW
    AuthMW --> UploadMW
    UploadMW --> RoomRoutes
    UploadMW --> BookingRoutes
    UploadMW --> ServiceRoutes
    UploadMW --> UserRoutes
    UploadMW --> AnalyticsRoutes

    RoomRoutes --> RoomController
    BookingRoutes --> BookingController
    ServiceRoutes --> ServiceController
    UserRoutes --> UserController
    AnalyticsRoutes --> AnalyticsController

    RoomController --> RoomModel
    BookingController --> BookingModel
    ServiceController --> ServiceModel
    UserController --> UserModel
    AnalyticsController --> BookingModel

    RoomModel --> MongoDB
    BookingModel --> MongoDB
    ServiceModel --> MongoDB
    UserModel --> MongoDB
    DBInit --> MongoDB

    %% File uploads
    RoomController -->|uploads| FileStorage
    UserController -->|uploads| FileStorage

    %% Auth interactions
    AuthMW --> JWTService

    %% Seeding
    SeedRooms --> MongoDB
    SeedBookings --> MongoDB
    SeedServices --> MongoDB
    SeedUsers --> MongoDB

    %% Click Events
    click Entry "https://github.com/saad0095/hotel-management-system/blob/main/index.js"
    click AuthMW "https://github.com/saad0095/hotel-management-system/blob/main/middlewares/authMiddleware.js"
    click UploadMW "https://github.com/saad0095/hotel-management-system/blob/main/middlewares/uploadMiddleware.js"
    click RoomRoutes "https://github.com/saad0095/hotel-management-system/blob/main/routes/roomRoutes.js"
    click BookingRoutes "https://github.com/saad0095/hotel-management-system/blob/main/routes/bookingRoutes.js"
    click ServiceRoutes "https://github.com/saad0095/hotel-management-system/blob/main/routes/serviceRoutes.js"
    click UserRoutes "https://github.com/saad0095/hotel-management-system/blob/main/routes/userRoutes.js"
    click AnalyticsRoutes "https://github.com/saad0095/hotel-management-system/blob/main/routes/analyticsRoutes.js"
    click RoomController "https://github.com/saad0095/hotel-management-system/blob/main/controllers/roomController.js"
    click BookingController "https://github.com/saad0095/hotel-management-system/blob/main/controllers/bookingController.js"
    click ServiceController "https://github.com/saad0095/hotel-management-system/blob/main/controllers/serviceController.js"
    click UserController "https://github.com/saad0095/hotel-management-system/blob/main/controllers/userController.js"
    click AnalyticsController "https://github.com/saad0095/hotel-management-system/blob/main/controllers/analyticsController.js"
    click RoomModel "https://github.com/saad0095/hotel-management-system/blob/main/models/room.js"
    click BookingModel "https://github.com/saad0095/hotel-management-system/blob/main/models/booking.js"
    click ServiceModel "https://github.com/saad0095/hotel-management-system/blob/main/models/service.js"
    click UserModel "https://github.com/saad0095/hotel-management-system/blob/main/models/user.js"
    click DBInit "https://github.com/saad0095/hotel-management-system/blob/main/db/index.js"
    click SeedRooms "https://github.com/saad0095/hotel-management-system/blob/main/seed/seedRooms.js"
    click SeedBookings "https://github.com/saad0095/hotel-management-system/blob/main/seed/seedBookings.js"
    click SeedServices "https://github.com/saad0095/hotel-management-system/blob/main/seed/seedServices.js"
    click SeedUsers "https://github.com/saad0095/hotel-management-system/blob/main/seed/seedUsers.js"

    %% Styles
    classDef internal fill:#BDD7EE,stroke:#333,stroke-width:1px
    classDef external fill:#FFF2CC,stroke:#333,stroke-width:1px
    classDef db fill:#C6E0B4,stroke:#333,stroke-width:1px
    classDef dashed stroke-dasharray: 5 5,fill:#f9f9f9,stroke:#333
```
