# kanzariya-maulik/airbnb architecture

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

- Interactive diagram: https://gitdiagram.com/kanzariya-maulik/airbnb
- Repository: https://github.com/kanzariya-maulik/airbnb

## Overview

##### Project type and purpose
- This is a full-stack web application replicating core Airbnb features: user signup/login, listing creation, listing search, reviews, image upload, and map display.

##### File structure
- app.js: main Express application entry point
- init/: database seeding or startup scripts
- routes/: URL endpoints grouped by resource (listing, review, user)
- controllers/: business logic for each route
- models/: Mongoose schemas for listings, users, reviews
- utils/: custom error class and async wrapper middleware
- middelware.js: global middleware (authentication checks, flash messages)
- public/: static assets (CSS, JS, images, client-side map code)
- views/: EJS templates (layouts, partials, page views)
- cloudConfig.js: Cloudinary configuration
- Schema.js: Joi validation schemas

##### README for additional insights
- Backend stack: Node.js, Express.js, MongoDB/Mongoose
- Frontend stack: EJS templates, Bootstrap, custom CSS/JS
- Authentication: Passport.js (local strategy)
- Form validation: Joi
- External services: Mapbox for maps, Cloudinary for image upload
- Hosting: Render

##### Main components
a. Client Browser (Frontend)
- EJS-rendered pages
- Static assets: CSS, JS (map integration)
- Forms for signup/login, listing CRUD, review submission
b. Web Server (Backend – Express.js)
- Routing layer (routes/*.js)
- Middleware stack (middelware.js, wrapAsync, session, passport)
- Controllers (controllers/*.js)
- Validation layer (Joi schemas in Schema.js)
c. Data Layer
- MongoDB database
- Mongoose models (models/*.js)
- Init scripts to seed or configure
d. External Services
- Cloudinary (image storage/upload)
- Mapbox API (geolocation, map tiles)
e. Supporting Modules
- utils/ExpressError.js (error handling)
- utils/wrapAsync.js (async error wrapper)

##### Relationships and interactions
- Client → HTTP requests → Express routes
- Route handlers → call validation → controller logic
- Controllers → read/write → MongoDB via Mongoose
- Controllers → upload images → Cloudinary
- Views rendered server-side with dynamic data
- Client-side map scripts → call Mapbox API
- Passport.js → manages authentication flow (session cookies)

##### Architectural patterns and design principles
- MVC-like separation: Models, Controllers, Views
- Single-page form flows with server-side rendering
- Layered middleware for cross-cutting concerns (auth, validation, error handling)
- Modular routing for resource grouping
- Externalization of configuration (cloudConfig.js, .env)

##### Essential elements
- Session store/auth layer around Passport.js
- Static assets served from public/ directory

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Client Browser (Frontend)"
        direction TB
        EJS["EJS Templates"]:::frontend
        Static["Static Assets (CSS/JS)"]:::frontend
        MapboxScr["Mapbox Integration Script"]:::frontend
    end

    %% Server Layer
    subgraph "Express Server (Backend)"
        direction TB
        App["app.js (Entry Point)"]:::backend

        subgraph "Routing Layer"
            direction TB
            LR["Listing Routes"]:::backend
            RR["Review Routes"]:::backend
            UR["User Routes"]:::backend
        end

        subgraph "Middleware & Helpers"
            direction TB
            Middleware["Global Middleware"]:::backend
            AsyncWrap["Async Wrapper"]:::backend
            ErrClass["Custom Error Class"]:::backend
            Auth["Passport & Session"]:::backend
        end

        Validation["Joi Validation"]:::backend
        subgraph "Controllers"
            direction TB
            LC["ListingController"]:::backend
            RC["ReviewController"]:::backend
            UC["UserController"]:::backend
        end
    end

    %% Data Layer
    subgraph "Database"
        direction TB
        MongoDB["MongoDB"]:::data
        subgraph "Models"
            direction TB
            MList["Listings Model"]:::data
            MRev["Reviews Model"]:::data
            MUser["Users Model"]:::data
        end
        subgraph "Init Scripts"
            direction TB
            InitIndex["init/index.js"]:::data
            InitData["init/data.js"]:::data
        end
    end

    %% External Services
    subgraph "External Services"
        direction TB
        Cloudinary["Cloudinary"]:::external
        MapboxAPI["Mapbox API"]:::external
    end

    %% Connections
    EJS -->|renders pages| App
    Static -->|serves assets| App
    MapboxScr -->|client calls| MapboxAPI

    EJS -->|form submits| LR
    RR -->|routes| App
    UR -->|routes| App

    App --> LR
    App --> RR
    App --> UR

    LR --> Validation
    RR --> Validation
    UR --> Validation

    Validation --> LC
    Validation --> RC
    Validation --> UC

    Middleware --> LR
    Middleware --> RR
    Middleware --> UR
    AsyncWrap --> LR
    AsyncWrap --> RR
    AsyncWrap --> UR
    ErrClass --> LR
    ErrClass --> RR
    ErrClass --> UR
    Auth --> LR
    Auth --> RR
    Auth --> UR

    LC -->|CRUD| MongoDB
    RC -->|CRUD| MongoDB
    UC -->|CRUD| MongoDB

    MList --> MongoDB
    MRev --> MongoDB
    MUser --> MongoDB

    LC -->|upload images| Cloudinary
    RC -->|reviews persist| MongoDB
    UC -->|profile images| Cloudinary

    %% Click Events
    click EJS "https://github.com/kanzariya-maulik/airbnb/tree/main/views/"
    click Static "https://github.com/kanzariya-maulik/airbnb/tree/main/public/css/"
    click Static "https://github.com/kanzariya-maulik/airbnb/tree/main/public/script/"
    click MapboxScr "https://github.com/kanzariya-maulik/airbnb/blob/main/public/script/map.js"
    click App "https://github.com/kanzariya-maulik/airbnb/blob/main/app.js"
    click LR "https://github.com/kanzariya-maulik/airbnb/blob/main/routes/listing.js"
    click RR "https://github.com/kanzariya-maulik/airbnb/blob/main/routes/review.js"
    click UR "https://github.com/kanzariya-maulik/airbnb/blob/main/routes/user.js"
    click Middleware "https://github.com/kanzariya-maulik/airbnb/blob/main/middelware.js"
    click AsyncWrap "https://github.com/kanzariya-maulik/airbnb/blob/main/utils/wrapAsync.js"
    click ErrClass "https://github.com/kanzariya-maulik/airbnb/blob/main/utils/ExpressError.js"
    click LC "https://github.com/kanzariya-maulik/airbnb/blob/main/controllers/listingController.js"
    click RC "https://github.com/kanzariya-maulik/airbnb/blob/main/controllers/reviewController.js"
    click UC "https://github.com/kanzariya-maulik/airbnb/blob/main/controllers/userController.js"
    click Validation "https://github.com/kanzariya-maulik/airbnb/blob/main/Schema.js"
    click MList "https://github.com/kanzariya-maulik/airbnb/blob/main/models/listings.js"
    click MRev "https://github.com/kanzariya-maulik/airbnb/blob/main/models/review.js"
    click MUser "https://github.com/kanzariya-maulik/airbnb/blob/main/models/user.js"
    click InitIndex "https://github.com/kanzariya-maulik/airbnb/blob/main/init/index.js"
    click InitData "https://github.com/kanzariya-maulik/airbnb/blob/main/init/data.js"
    click Cloudinary "https://github.com/kanzariya-maulik/airbnb/blob/main/cloudConfig.js"

    %% Styles
    classDef frontend fill:#D6E9FF,stroke:#333,stroke-width:1px
    classDef backend fill:#D4F4DD,stroke:#333,stroke-width:1px
    classDef data fill:#F0E0FF,stroke:#333,stroke-width:1px
    classDef external fill:#FFE0B2,stroke:#333,stroke-width:1px
```
