# ruthvikmaturu/campus-connect architecture

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

- Interactive diagram: https://gitdiagram.com/ruthvikmaturu/campus-connect
- Repository: https://github.com/ruthvikmaturu/campus-connect

## Overview

##### Project Type and Purpose
- This is a full-stack web application (“Campus Connect”) that pairs junior and senior students for mentorship.
- Frontend: React + Vite; Backend: Node.js + Express; Database: MongoDB; Real-time chat; File storage (Cloudinary); Email notifications.

##### File Structure
- Top-level:
- public / index.html → Static assets and the HTML shell
- src/ → React app code (components, pages, context, utils, theme, assets)
- server/ → Express API (config, middleware, models, routes, scripts, utils)
- Config files (.eslintrc.js, tailwind.config.js, vite.config.js, package.json, etc.)
- Patterns:
- Frontend: Component-based UI with Context for Auth & Theme
- Backend: MVC-style (models in server/models, routes in server/routes, middleware in server/middleware)
- Scripts for seeding data and maintenance (server/scripts)

##### Key Architectural Insights from the README
- JWT authentication for students/admin
- Real-time personal & group chat
- File uploads (profile pics, event images) via Cloudinary
- Email notifications via a mail service module
- Admin vs student roles with separate dashboards and routes

##### Main Components and Their Interactions
A. Frontend (React App)
- Pages & Components (Login, Register, Chat, Events, Experiences, Admin Dashboard, etc.)
- Context Providers (AuthContext for JWT, ThemeContext for dark mode)
- HTTP client (axiosConfig.js) to call backend API
- Optional: Firebase integration (src/firebase.js) for notifications/push

B. API Server (Express)
- Entry point: server/server.js
- Middleware: auth.js, adminAuth.js for route protection
- Routes: Auth, Chat, GroupChat, Event, Experience, Student
- Controllers/Models: MongoDB schema definitions (User, Student, Chat, etc.)
- Utilities: cloudinary.js for file uploads, email/emailService.js for messaging

C. Data Layer
- MongoDB (hosted locally or in cloud like Atlas)
- Collections: users, students, events, experiences, chats, groupchats

D. External Services
- Cloudinary for media storage
- Email provider (SMTP/SendGrid, abstracted in emailService.js)
- (Optional) Firebase for push notifications

##### Architectural Patterns & Design Principles
- Separation of concerns:
- UI vs business logic vs data access
- RESTful API design
- JWT-based stateless authentication
- MVC structure on backend
- Component & Context patterns on frontend
- Real-time comms (consider representing WebSocket / Socket.io if used)

## Diagram (Mermaid)

```mermaid
flowchart TB
    User["User (Browser)"]:::external

    subgraph "Frontend (React + Vite)"
        direction TB
        HTML["public/index.html"]:::frontend
        Main["src/main.jsx"]:::frontend
        App["src/App.jsx / src/App.css"]:::frontend
        Components["src/components/"]:::frontend
        Pages["src/pages/"]:::frontend
        AuthCtx["src/context/AuthContext.jsx"]:::frontend
        ThemeCtx["src/theme/ThemeContext.jsx"]:::frontend
        AxiosCfg["src/utils/axiosConfig.js"]:::frontend
        Firebase["src/firebase.js"]:::frontend
    end

    subgraph "API Server (Express.js)"
        direction TB
        Server["server/server.js"]:::backend
        CloudCfg["server/config/cloudinary.js"]:::backend
        AuthMw["server/middleware/auth.js"]:::backend
        AdminMw["server/middleware/adminAuth.js"]:::backend
        AuthRoute["server/routes/Auth.js"]:::backend
        ChatRoute["server/routes/Chat.js"]:::backend
        EventRoute["server/routes/Event.js"]:::backend
        ExpRoute["server/routes/Experience.js"]:::backend
        StudentRoute["server/routes/Student.js"]:::backend
        UserModel["server/models/User.js"]:::backend
        StudentModel["server/models/Student.js"]:::backend
        ChatModel["server/models/Chat.js"]:::backend
        GroupChatModel["server/models/GroupChat.js"]:::backend
        EventModel["server/models/Event.js"]:::backend
        ExpModel["server/models/Experience.js"]:::backend
        EmailUtil["server/utils/email.js"]:::backend
        EmailService["server/utils/emailService.js"]:::backend
        Scripts["server/scripts/"]:::backend
    end

    DB[(MongoDB)]:::database

    subgraph "External Services"
        direction TB
        Cloudinary["Cloudinary"]:::externalService
        EmailProv["SMTP/SendGrid"]:::externalService
    end

    User -->|"Interacts via UI"| HTML
    HTML -->|"Loads React App"| Main
    Main --> App
    App --> Components
    App --> Pages
    App --> AuthCtx
    App --> ThemeCtx
    App --> AxiosCfg
    App --> Firebase

    AxiosCfg -->|"HTTP/JSON"| AuthRoute
    AxiosCfg --> ChatRoute
    AxiosCfg --> EventRoute
    AxiosCfg --> ExpRoute
    AxiosCfg --> StudentRoute

    AuthRoute --> AuthMw
    AuthRoute -->|"Controller"| UserModel
    AuthRoute -->|"Controller"| StudentModel

    ChatRoute --> AuthMw
    ChatRoute --> ChatModel
    ChatRoute --> GroupChatModel

    EventRoute --> AuthMw
    EventRoute --> EventModel
    ExpRoute --> AuthMw
    ExpRoute --> ExpModel

    StudentRoute --> AuthMw
    StudentRoute --> StudentModel

    Server --> CloudCfg
    Server --> EmailService
    EmailService --> EmailUtil
    EmailService --> EmailProv

    AuthMw -->|"JWT Validation"| Server
    AdminMw -->|"Role Check"| Server

    UserModel -.-> DB
    StudentModel -.-> DB
    ChatModel -.-> DB
    GroupChatModel -.-> DB
    EventModel -.-> DB
    ExpModel -.-> DB

    AuthRoute -->|"File Upload"| CloudCfg
    CloudCfg --> Cloudinary

    EventRoute -->|"Email Notifications"| EmailService

    ChatRoute -->|"WebSocket"| User

    classDef frontend fill:#ccffcc,stroke:#333,stroke-width:1px
    classDef backend fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef database fill:#ffddb3,stroke:#333,stroke-width:1px
    classDef externalService fill:#e5ccff,stroke:#333,stroke-width:1px
    classDef external fill:#f0f0f0,stroke:#333,stroke-width:1px

    click HTML "https://github.com/ruthvikmaturu/campus-connect/blob/main/public/index.html"
    click Main "https://github.com/ruthvikmaturu/campus-connect/blob/main/src/main.jsx"
    click App "https://github.com/ruthvikmaturu/campus-connect/blob/main/src/App.jsx"
    click Components "https://github.com/ruthvikmaturu/campus-connect/tree/main/src/components/"
    click Pages "https://github.com/ruthvikmaturu/campus-connect/tree/main/src/pages/"
    click AuthCtx "https://github.com/ruthvikmaturu/campus-connect/blob/main/src/context/AuthContext.jsx"
    click ThemeCtx "https://github.com/ruthvikmaturu/campus-connect/blob/main/src/theme/ThemeContext.jsx"
    click AxiosCfg "https://github.com/ruthvikmaturu/campus-connect/blob/main/src/utils/axiosConfig.js"
    click Firebase "https://github.com/ruthvikmaturu/campus-connect/blob/main/src/firebase.js"
    click Server "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/server.js"
    click CloudCfg "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/config/cloudinary.js"
    click AuthMw "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/middleware/auth.js"
    click AdminMw "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/middleware/adminAuth.js"
    click AuthRoute "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/routes/Auth.js"
    click ChatRoute "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/routes/Chat.js"
    click EventRoute "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/routes/Event.js"
    click ExpRoute "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/routes/Experience.js"
    click StudentRoute "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/routes/Student.js"
    click UserModel "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/models/User.js"
    click StudentModel "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/models/Student.js"
    click ChatModel "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/models/Chat.js"
    click GroupChatModel "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/models/GroupChat.js"
    click EventModel "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/models/Event.js"
    click ExpModel "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/models/Experience.js"
    click EmailUtil "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/utils/email.js"
    click EmailService "https://github.com/ruthvikmaturu/campus-connect/blob/main/server/utils/emailService.js"
    click Scripts "https://github.com/ruthvikmaturu/campus-connect/tree/main/server/scripts/"
```
