# ishu077/course_project_bnb architecture

> Architecture diagram of the GitHub repository ishu077/course_project_bnb, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ishu077/course_project_bnb
- Repository: https://github.com/ishu077/course_project_bnb

## Overview

##### Project type and purpose
- WanderLust is a full-stack MVC web application for booking BnB stays (“Airbnb-like”)
- Key capabilities: user signup/login, CRUD listings & reviews, map display, cloud image upload

##### File structure
- app.js: Express application entrypoint
- cloudConfig.js: Cloudinary configuration
- init/: database seeding
- Models/: Mongoose models (User, Listing, Review)
- controllers/: business logic for listings, reviews, users
- routes/: Express route definitions
- middleware.js: auth checks, error handling
- utils/: error classes, async wrapper
- schema.js: JOI validation schemas
- public/: static assets (CSS, JS, client-side scripts)
- views/: EJS templates (layouts, partials, pages)
- uploads/: temporary file storage for Multer

##### README for stack and features
- Frontend: EJS, Bootstrap, custom CSS/JS, Mapbox integration
- Backend: Node.js + Express, MongoDB + Mongoose, Passport.js, Multer, Cloudinary
- External services: Cloudinary for images, Mapbox for maps

##### Main components and their interactions
A. Client (Browser)
- Sends HTTP requests (GET, POST, PUT, DELETE)
- Renders HTML from EJS, executes client-side JS (map.js, script.js)
B. CDN / Static Server
- public/ served via Express.static
- Assets: CSS, JS, images (mapbox scripts)
C. Express Server
- app.js sets up middleware (session, passport, flash, body-parser, multer)
- Routes → Controllers → Models/Services
D. Controllers & Services
- controllers/**: orchestrate CRUD flows
- schema.js + middleware.js validate and sanitize input
- utils/wrapAsync and expressError enforce uniform error handling
E. Data Layer
- Mongoose models under Models/
- MongoDB Atlas (DB_URL) stores users, listings, reviews
F. External Services
- Cloudinary: image upload via multer-storage (cloudConfig.js)
- Mapbox: geocoding/maps in client JS
G. Init Module (optional)
- init/index.js seeds test data

##### Architectural patterns & design principles
- MVC pattern: Routes → Controllers → Models → Views
- Layered architecture:
- Presentation (EJS + static assets)
- Application (Express middleware + controllers)
- Persistence (Mongoose → MongoDB)
- Integration (Cloudinary, Mapbox)
- Single monolithic service (no microservices), but clear separation by folder

##### Details
- Authentication flow: User → Passport → Session store
- File upload flow: Browser → Multer → Cloudinary → DB (image URL)
- Validation: Routes → JOI schema → Controllers
- Error handling: Controllers → expressError middleware → Error view

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Lane
    subgraph "Frontend" 
        direction TB
        Client["Browser UI (EJS Templates)"]:::frontend
        Static["Static Assets (CSS/JS)"]:::frontend
        MapboxClient["Mapbox Integration (public/js/map.js)"]:::frontend
    end

    %% Backend Lane
    subgraph "Backend" 
        direction TB
        App["Express App (app.js)"]:::backend
        Middleware["Middleware (middleware.js)"]:::backend
        Validation["Validation (schema.js)"]:::backend
        subgraph "Route Layer"
            direction TB
            listingRoute["Listing Routes"]:::backend
            reviewRoute["Review Routes"]:::backend
            userRoute["User Routes"]:::backend
        end
        subgraph "Controller Layer"
            direction TB
            listingCtrl["Listing Controller"]:::backend
            reviewCtrl["Review Controller"]:::backend
            userCtrl["User Controller"]:::backend
        end
        subgraph "Data Layer"
            direction TB
            listingModel["Listing Model"]:::datastore
            reviewModel["Review Model"]:::datastore
            userModel["User Model"]:::datastore
        end
        Utils["Utils (expressError, wrapAsync)"]:::backend
        Uploads["File Uploads (uploads/)"]:::backend
        CloudConfig["Cloudinary Config (cloudConfig.js)"]:::backend
        InitModule["Init Module (init/index.js)"]:::backend
    end

    %% External Services
    subgraph "External Services"
        direction TB
        Cloudinary["Cloudinary"]:::ext
        MapboxServer["Mapbox Geocoding"]:::ext
    end

    %% Database
    Database["MongoDB Atlas"]:::datastore

    %% Client-side View Components
    Client --> Static
    Client --> App
    Client --> MapboxClient
    MapboxClient -->|"geocode requests"| MapboxServer

    %% Express Flow
    App --> Middleware
    Middleware --> Validation
    Validation --> listingRoute
    Validation --> reviewRoute
    Validation --> userRoute

    listingRoute -->|calls| listingCtrl
    reviewRoute -->|calls| reviewCtrl
    userRoute -->|calls| userCtrl

    listingCtrl -->|uses| listingModel
    reviewCtrl -->|uses| reviewModel
    userCtrl -->|uses| userModel

    listingCtrl -->|upload image| CloudConfig
    CloudConfig -->|store image| Cloudinary
    Cloudinary -->|return URL| listingCtrl

    listingModel --> Database
    reviewModel --> Database
    userModel --> Database

    listingCtrl --> Utils
    reviewCtrl --> Utils
    userCtrl --> Utils

    App -->|seed data| InitModule
    InitModule --> InitData["init/data.js"]:::backend
    App -->|render error| ErrorView["Error View (views/error.ejs)"]:::frontend
    Client -->|renders| Layout["Layout (views/layouts/boilerplates.ejs)"]:::frontend
    Client -->|includes| Navbar["Navbar (views/includes/navbar.ejs)"]:::frontend
    Client -->|includes| Footer["Footer (views/includes/footer.ejs)"]:::frontend
    Client -->|displays| Flash["Flash Messages (views/includes/flash.ejs)"]:::frontend

    %% Click Events
    click Client "https://github.com/ishu077/course_project_bnb/tree/main/views/"
    click Static "https://github.com/ishu077/course_project_bnb/tree/main/public/css/"
    click Static "https://github.com/ishu077/course_project_bnb/tree/main/public/js/"
    click MapboxClient "https://github.com/ishu077/course_project_bnb/blob/main/public/js/map.js"
    click App "https://github.com/ishu077/course_project_bnb/blob/main/app.js"
    click CloudConfig "https://github.com/ishu077/course_project_bnb/blob/main/cloudConfig.js"
    click Middleware "https://github.com/ishu077/course_project_bnb/blob/main/middleware.js"
    click Validation "https://github.com/ishu077/course_project_bnb/blob/main/schema.js"
    click listingRoute "https://github.com/ishu077/course_project_bnb/blob/main/routes/listing.js"
    click reviewRoute "https://github.com/ishu077/course_project_bnb/blob/main/routes/review.js"
    click userRoute "https://github.com/ishu077/course_project_bnb/blob/main/routes/user.js"
    click listingCtrl "https://github.com/ishu077/course_project_bnb/blob/main/controllers/listings.js"
    click reviewCtrl "https://github.com/ishu077/course_project_bnb/blob/main/controllers/reviews.js"
    click userCtrl "https://github.com/ishu077/course_project_bnb/blob/main/controllers/users.js"
    click listingModel "https://github.com/ishu077/course_project_bnb/blob/main/Models/listing.js"
    click reviewModel "https://github.com/ishu077/course_project_bnb/blob/main/Models/review.js"
    click userModel "https://github.com/ishu077/course_project_bnb/blob/main/Models/user.js"
    click Utils "https://github.com/ishu077/course_project_bnb/blob/main/utils/expressError.js"
    click Utils "https://github.com/ishu077/course_project_bnb/blob/main/utils/wrapAsync.js"
    click Uploads "https://github.com/ishu077/course_project_bnb/tree/main/uploads/"
    click InitModule "https://github.com/ishu077/course_project_bnb/blob/main/init/index.js"
    click InitData "https://github.com/ishu077/course_project_bnb/blob/main/init/data.js"
    click ErrorView "https://github.com/ishu077/course_project_bnb/blob/main/views/error.ejs"
    click Layout "https://github.com/ishu077/course_project_bnb/blob/main/views/layouts/boilerplates.ejs"
    click Navbar "https://github.com/ishu077/course_project_bnb/blob/main/views/includes/navbar.ejs"
    click Footer "https://github.com/ishu077/course_project_bnb/blob/main/views/includes/footer.ejs"
    click Flash "https://github.com/ishu077/course_project_bnb/blob/main/views/includes/flash.ejs"

    %% Styles
    classDef frontend fill:#E3F2FD,stroke:#0288D1,color:#01579B;
    classDef backend fill:#E8F5E9,stroke:#388E3C,color:#1B5E20;
    classDef datastore fill:#FFF3E0,stroke:#F57C00,color:#E65100;
    classDef ext fill:#F3E5F5,stroke:#8E24AA,color:#6A1B9A
```
