# bhavukadlakha/myweb architecture

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

- Interactive diagram: https://gitdiagram.com/bhavukadlakha/myweb
- Repository: https://github.com/bhavukadlakha/myweb

## Overview

##### Project Type and Purpose
- This is a backend API (Node.js + Express) with a MongoDB data store.
- It manages college appointment booking: students and professors register/login, professors publish availability slots, students book or cancel appointments.

##### Key Architectural Layers (inferred from the file tree & README)
- Entry Point & App Setup
- server.js — starts HTTP server, imports app.js
- app.js — configures Express, middleware, routes
- .env — holds PORT, MONGODB_URI, JWT_SECRET
- HTTP API Layer
- routes/*.js — Express routers for `/api/auth`, `/api/availability`, `/api/appointments`
- Controller Layer
- controllers/*Controller.js — handle request logic, validation, response formatting
- Middleware
- middleware/auth.js — JWT validation, role checks
- Data Layer
- models/*.js — Mongoose schemas for Student, Availability, Appointment
- node_modules — Mongoose, Express, jsonwebtoken, etc.
- MongoDB — persistent storage, accessed via Mongoose models
- Test Suite
- tests/e2e.test.js — end-to-end flows that hit every layer

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client & Tests
    subgraph "Client & Tests"
        Client["HTTP Client\n(Postman/Frontend)"]:::external
        Tests["E2E Tests"]:::external
    end

    %% Entry & App Setup
    subgraph "Entry & App Setup"
        Server["server.js"]:::entry
        App["app.js"]:::entry
        Env[".env"]:::entry
    end

    %% Middleware
    subgraph "Middleware"
        AuthMid["auth.js\n/middleware/auth.js"]:::middleware
    end

    %% HTTP API Layer
    subgraph "HTTP API Layer"
        AuthRoutes["Auth Routes\n/routes/authRoutes.js"]:::routes
        AvailRoutes["Availability Routes\n/routes/availabilityRoutes.js"]:::routes
        ApptRoutes["Appointment Routes\n/routes/appointmentRoutes.js"]:::routes
    end

    %% Controller Layer
    subgraph "Controller Layer"
        AuthCtrl["Auth Controller\n/controllers/authcontroller.js"]:::controller
        AvailCtrl["Availability Controller\n/controllers/availabilitycontroller.js"]:::controller
        ApptCtrl["Appointment Controller\n/controllers/appointmentcontroller.js"]:::controller
    end

    %% Data Layer
    subgraph "Data Layer"
        StudentModel["Student Model\n/models/Student.js"]:::model
        AvailModel["Availability Model\n/models/Availability.js"]:::model
        ApptModel["Appointment Model\n/models/Appointment.js"]:::model
    end

    %% Infrastructure & Services
    subgraph "Infrastructure & Services"
        MongoDB["MongoDB"]:::infra
        JWT["jsonwebtoken"]:::infra
        DotEnv["dotenv"]:::infra
        NodeMods["node_modules"]:::infra
        Package["package.json\n& package-lock.json"]:::infra
        README["README.md"]:::infra
    end

    %% Flows
    Client -->|"HTTP Request"| Server
    Tests -->|"HTTP Request"| Server
    Server -->|"import"| App
    App -->|"load env vars"| DotEnv
    App -->|"use auth middleware"| AuthMid
    App --> AuthRoutes
    App --> AvailRoutes
    App --> ApptRoutes

    AuthRoutes -->|"invoke"| AuthCtrl
    AvailRoutes -->|"invoke"| AvailCtrl
    ApptRoutes -->|"invoke"| ApptCtrl

    AuthCtrl -->|"Mongoose.find()/save()"| StudentModel
    AvailCtrl -->|"Mongoose.find()/save()"| AvailModel
    ApptCtrl -->|"Mongoose.find()/save()"| ApptModel

    StudentModel -->|"CRUD ops"| MongoDB
    AvailModel -->|"CRUD ops"| MongoDB
    ApptModel -->|"CRUD ops"| MongoDB

    AuthCtrl -->|"sign/verify tokens"| JWT

    %% Click Events
    click Server "https://github.com/bhavukadlakha/myweb/blob/main/server.js"
    click App "https://github.com/bhavukadlakha/myweb/blob/main/app.js"
    click Env "https://github.com/bhavukadlakha/myweb/blob/main/.env"
    click AuthMid "https://github.com/bhavukadlakha/myweb/blob/main/middleware/auth.js"
    click AuthRoutes "https://github.com/bhavukadlakha/myweb/blob/main/routes/authRoutes.js"
    click AvailRoutes "https://github.com/bhavukadlakha/myweb/blob/main/routes/availabilityRoutes.js"
    click ApptRoutes "https://github.com/bhavukadlakha/myweb/blob/main/routes/appointmentRoutes.js"
    click AuthCtrl "https://github.com/bhavukadlakha/myweb/blob/main/controllers/authcontroller.js"
    click AvailCtrl "https://github.com/bhavukadlakha/myweb/blob/main/controllers/availabilitycontroller.js"
    click ApptCtrl "https://github.com/bhavukadlakha/myweb/blob/main/controllers/appointmentcontroller.js"
    click StudentModel "https://github.com/bhavukadlakha/myweb/blob/main/models/Student.js"
    click AvailModel "https://github.com/bhavukadlakha/myweb/blob/main/models/Availability.js"
    click ApptModel "https://github.com/bhavukadlakha/myweb/blob/main/models/Appointment.js"
    click Tests "https://github.com/bhavukadlakha/myweb/blob/main/tests/e2e.test.js"
    click Package "https://github.com/bhavukadlakha/myweb/blob/main/package.json"
    click NodeMods "https://github.com/bhavukadlakha/myweb/tree/main/node_modules/"
    click README "https://github.com/bhavukadlakha/myweb/blob/main/README.md"

    %% Styles
    classDef entry fill:#E3F2FD,stroke:#1E88E5,stroke-width:1px;
    classDef routes fill:#BBDEFB,stroke:#1976D2,stroke-width:1px;
    classDef controller fill:#C8E6C9,stroke:#388E3C,stroke-width:1px;
    classDef model fill:#FFF9C4,stroke:#FBC02D,stroke-width:1px;
    classDef infra fill:#E0E0E0,stroke:#616161,stroke-width:1px;
    classDef middleware fill:#FFECB3,stroke:#FFA000,stroke-width:1px;
    classDef external fill:#F3E5F5,stroke:#8E24AA,stroke-width:1px;
```
