# jaimin05/mindbend architecture

> Architecture diagram of the GitHub repository jaimin05/mindbend, 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/jaimin05/mindbend
- Repository: https://github.com/jaimin05/mindbend

## Overview

##### Project Type and Purpose
- CareCrew is a full-stack web application that connects motorists in distress with roadside assistance providers.
- It consists of a React/TypeScript/Vite frontend and an Express/Node.js/MongoDB backend, deployed to Vercel.

##### Main Components
a. Client Layer
- Web Browser / Single-Page App
- React UI (pages, components, context providers)
b. Frontend Application
- Routing / Vite dev/build
- UI Components (Dashboards, Maps, Forms)
- Services layer calling backend APIs (emergency.service.ts, request.service.ts, map.service.ts)
- External SDKs (Mapbox, toast notifications)
c. API Layer (Backend)
- Express.js server (app.js)
- Routing modules (auth.route.js, emergency.route.js, etc.)
- Controllers (handle business logic)
- Middleware (auth.middleware.js for JWT verification)
- Utility modules (mailer.js for email, responseFormatter.js)
d. Data Layer
- MongoDB database
- Mongoose ODM models (User, Admin, ServiceProvider, Emergency, Request)
- Migration script (migration.js)
e. External Services
- Email Service (Nodemailer SMTP or third-party)
- Mapbox API (for geolocation, maps)
- AI/ML service via groq-sdk if relevant
f. Deployment & Infrastructure
- Vercel configuration for frontend and backend
- Environment variables (JWT secret, DB URI, email creds)

##### Relationships and Data Flows
- User interacts with React SPA in browser → SPA calls Express REST API over HTTPS.
- Auth flow: login/register → backend issues JWT → frontend stores token (AuthContext).
- Emergency request flow: SPA posts location/request → backend validates → saves Emergency record → geospatial lookup for nearest ServiceProvider → notify provider → provider UI update → SPA polls or pushes updates for real-time tracking.
- Data persistence: Controllers ↔ Mongoose models ↔ MongoDB.
- Notifications: backend uses mailer.js or websockets/third‐party push (if implemented).
- Integration: frontend uses Mapbox SDK → fetch tile data from Mapbox API.

##### Architectural Patterns and Design Principles
- Layered architecture: Presentation (React) → API (Express) → Persistence (MongoDB).
- MVC‐inspired separation in backend: Routes → Controllers → Models.
- JWT‐based stateless authentication.
- Context/Service pattern in frontend for state management and API calls.
- Clear contract via REST endpoints.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Client Layer
    Browser["Web Browser"]:::frontend
    subgraph "Frontend Application"
        direction TB
        ReactSPA["React SPA"]:::frontend
        click ReactSPA "https://github.com/jaimin05/mindbend/tree/main/frontend/src"
        subgraph "Entry & Config"
            Main["main.tsx"]:::frontend
            click Main "https://github.com/jaimin05/mindbend/blob/main/frontend/src/main.tsx"
            App["App.tsx"]:::frontend
            click App "https://github.com/jaimin05/mindbend/blob/main/frontend/src/App.tsx"
            Vite["vite.config.ts"]:::frontend
            click Vite "https://github.com/jaimin05/mindbend/blob/main/frontend/vite.config.ts"
        end
        subgraph "Pages & UI"
            Pages["Pages"]:::frontend
            click Pages "https://github.com/jaimin05/mindbend/tree/main/frontend/src/pages"
            Components["UI Components"]:::frontend
            click Components "https://github.com/jaimin05/mindbend/tree/main/frontend/src/components"
            UIlib["UI Library"]:::frontend
            click UIlib "https://github.com/jaimin05/mindbend/tree/main/frontend/src/components/ui"
        end
        subgraph "State Management"
            AuthCtx["AuthContext"]:::frontend
            click AuthCtx "https://github.com/jaimin05/mindbend/blob/main/frontend/src/contexts/AuthContext.tsx"
            DataCtx["DataContext"]:::frontend
            click DataCtx "https://github.com/jaimin05/mindbend/blob/main/frontend/src/contexts/DataContext.tsx"
        end
        subgraph "Services Layer"
            EmergencySvc["emergency.service.ts"]:::frontend
            click EmergencySvc "https://github.com/jaimin05/mindbend/blob/main/frontend/src/services/emergency.service.ts"
            RequestSvc["request.service.ts"]:::frontend
            click RequestSvc "https://github.com/jaimin05/mindbend/blob/main/frontend/src/services/request.service.ts"
            MapSvc["map.service.ts"]:::frontend
            click MapSvc "https://github.com/jaimin05/mindbend/blob/main/frontend/src/services/map.service.ts"
        end
        subgraph "Utilities & SDKs"
            Toast["toast.ts"]:::frontend
            click Toast "https://github.com/jaimin05/mindbend/blob/main/frontend/src/lib/toast.ts"
            Utils["utils.ts"]:::frontend
            click Utils "https://github.com/jaimin05/mindbend/blob/main/frontend/src/lib/utils.ts"
        end
    end

    %% Backend API Layer
    subgraph "Backend API" 
        direction TB
        AppJS["app.js"]:::api
        click AppJS "https://github.com/jaimin05/mindbend/blob/main/backend/app.js"
        subgraph "Routes"
            AuthRoute["auth.route.js"]:::api
            click AuthRoute "https://github.com/jaimin05/mindbend/blob/main/backend/routes/auth.route.js"
            AdminRoute["admin.route.js"]:::api
            click AdminRoute "https://github.com/jaimin05/mindbend/blob/main/backend/routes/admin.route.js"
            EmergencyRoute["emergency.route.js"]:::api
            click EmergencyRoute "https://github.com/jaimin05/mindbend/blob/main/backend/routes/emergency.route.js"
            RequestRoute["request.route.js"]:::api
            click RequestRoute "https://github.com/jaimin05/mindbend/blob/main/backend/routes/request.route.js"
            UserRoute["user.route.js"]:::api
            click UserRoute "https://github.com/jaimin05/mindbend/blob/main/backend/routes/user.route.js"
        end
        subgraph "Controllers"
            AuthCtrl["auth.controller.js"]:::api
            click AuthCtrl "https://github.com/jaimin05/mindbend/blob/main/backend/controllers/auth.controller.js"
            AdminCtrl["admin.controller.js"]:::api
            click AdminCtrl "https://github.com/jaimin05/mindbend/blob/main/backend/controllers/admin.controller.js"
            EmergencyCtrl["emergency.controller.js"]:::api
            click EmergencyCtrl "https://github.com/jaimin05/mindbend/blob/main/backend/controllers/emergency.controller.js"
            RequestCtrl["request.controller.js"]:::api
            click RequestCtrl "https://github.com/jaimin05/mindbend/blob/main/backend/controllers/request.controller.js"
            UserCtrl["user.controller.js"]:::api
            click UserCtrl "https://github.com/jaimin05/mindbend/blob/main/backend/controllers/user.controller.js"
        end
        AuthMiddleware["auth.middleware.js"]:::api
        click AuthMiddleware "https://github.com/jaimin05/mindbend/blob/main/backend/middleware/auth.middleware.js"
        subgraph "Utilities"
            Mailer["mailer.js"]:::api
            click Mailer "https://github.com/jaimin05/mindbend/blob/main/backend/utils/mailer.js"
            RespFmt["responseFormatter.js"]:::api
            click RespFmt "https://github.com/jaimin05/mindbend/blob/main/backend/utils/responseFormatter.js"
        end
        Migration["migration.js"]:::api
        click Migration "https://github.com/jaimin05/mindbend/blob/main/backend/migration.js"
        subgraph "Models"
            UserModel["user.model.js"]:::db
            click UserModel "https://github.com/jaimin05/mindbend/blob/main/backend/models/user.model.js"
            AdminModel["admin.model.js"]:::db
            click AdminModel "https://github.com/jaimin05/mindbend/blob/main/backend/models/admin.model.js"
            SPModel["serviceProvider.model.js"]:::db
            click SPModel "https://github.com/jaimin05/mindbend/blob/main/backend/models/serviceProvider.model.js"
            EmergencyModel["emergency.model.js"]:::db
            click EmergencyModel "https://github.com/jaimin05/mindbend/blob/main/backend/models/emergency.model.js"
            RequestModel["request.model.js"]:::db
            click RequestModel "https://github.com/jaimin05/mindbend/blob/main/backend/models/request.model.js"
        end
        subgraph "Deployment Config"
            BEVercel["backend/vercel.json"]:::api
            FEVercel["frontend/vercel.json"]:::frontend
        end
    end

    %% Data Layer
    MongoDB[(MongoDB)]:::db

    %% External Services
    subgraph "External Services"
        direction TB
        EmailSvc(["Email Service"]):::external
        MapboxAPI(["Mapbox API"]):::external
        AIService(["AI/ML Service"]):::external
    end

    %% Connections
    Browser -->|uses| ReactSPA
    ReactSPA -->|renders| Pages
    ReactSPA -->|renders| Components
    ReactSPA -->|uses| AuthCtx
    ReactSPA -->|uses| DataCtx
    ReactSPA -->|calls| EmergencySvc
    ReactSPA -->|calls| RequestSvc
    ReactSPA -->|calls| MapSvc
    EmergencySvc -->|REST API calls| AppJS
    RequestSvc -->|REST API calls| AppJS
    MapSvc -->|REST API calls| AppJS

    AuthCtx -->|stores JWT| Browser
    Browser -->|sends JWT| AuthMiddleware
    AuthMiddleware -->|verifies JWT| AuthCtrl

    AppJS -->|uses routes| AuthRoute
    AppJS -->|uses routes| AdminRoute
    AppJS -->|uses routes| EmergencyRoute
    AppJS -->|uses routes| RequestRoute
    AppJS -->|uses routes| UserRoute

    AuthRoute --> AuthCtrl
    AdminRoute --> AdminCtrl
    EmergencyRoute --> EmergencyCtrl
    RequestRoute --> RequestCtrl
    UserRoute --> UserCtrl

    AuthCtrl -->|CRUD| UserModel
    AdminCtrl -->|CRUD| AdminModel
    EmergencyCtrl -->|CRUD| EmergencyModel
    EmergencyCtrl -->|assigns| SPModel
    RequestCtrl -->|CRUD| RequestModel
    UserCtrl -->|CRUD| UserModel

    AuthCtrl -->|sends email| Mailer
    EmergencyCtrl -->|formats| RespFmt

    AuthCtrl -->|db| MongoDB
    AdminCtrl -->|db| MongoDB
    EmergencyCtrl -->|db| MongoDB
    RequestCtrl -->|db| MongoDB
    UserCtrl -->|db| MongoDB

    AppJS -->|runs migration| Migration

    AppJS -->|deploys via| BEVercel
    ReactSPA -->|deploys via| FEVercel

    AppJS -->|calls| EmailSvc
    AppJS -->|calls| MapboxAPI
    EmergencyCtrl -->|calls| AIService

    MongoDB --- EmergencyModel
    MongoDB --- UserModel

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366d6,stroke-width:1px
    classDef api fill:#DFFFE0,stroke:#238636,stroke-width:1px
    classDef db fill:#FFE4B5,stroke:#C76E00,stroke-width:1px
    classDef external fill:#E5E5E5,stroke:#6a737d,stroke-width:1px
```
