# kartik-katkar/organease architecture

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

- Interactive diagram: https://gitdiagram.com/kartik-katkar/organease
- Repository: https://github.com/kartik-katkar/organease

## Overview

##### Project type and purpose
- From the README and file tree, this is a full-stack MERN (MongoDB, Express, React, Node.js) web application called “OrganEase.”
- Purpose: to replace a manual organ-requesting workflow with a unified portal where procurement/transplant centres list available organs and hospitals request compatible organs (with payment integration).

##### File structure
- Top‐level directories:
- client/ – React single‐page application (SPA)
- server/ – Node.js + Express REST API
- Screenshots, README.md, LICENSE, Data Privacy.pdf, vercel.json
- client/:
- public/ – static HTML/CSS
- src/ – React code, organized into components for admin and shop (hospital) sides, each with their own contexts, modals, protected routes, partials.
- serviceWorker.js, index.js – startup
- server/:
- config/ – DB connection, environment keys, upload folder script
- controller/ – business logic per resource (auth, products, orders, categories, users, braintree, customize)
- models/ – Mongoose schemas
- routes/ – Express route definitions
- middleware/ – auth guard
- server.js – application entry point
- Key patterns: client–server separation, React Context for state, MVC on the server, RESTful JSON APIs, token-based auth, Braintree payment integration.

##### Extract additional insights from the README
- Requires Node.js/NPM, MongoDB connection string via environment variable.
- Two processes: `npm start` in client and `npm start:dev` in server.
- URL: http://localhost:3000/
- Images of the UI illustrate an admin dashboard for managing organs/products/categories/orders and a hospital (“shop”) portal for browsing, checkout, and order history.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Browser
    Browser["User Browser"]:::external

    %% Frontend
    subgraph "Frontend (React SPA)"
        direction TB
        App["App.js"]:::frontend
        Index["index.js"]:::frontend
        subgraph "Admin UI Module"
            direction TB
            AdminUI["Admin UI Module"]:::frontend
            AdminProtectedRoute["AdminProtectedRoute"]:::frontend
            subgraph "Admin Contexts"
                direction TB
                CatCtx["CategoryContext"]:::frontend
                DashCtxA["DashboardContext"]:::frontend
                OrderCtxA["OrderContext"]:::frontend
                ProdCtxA["ProductContext"]:::frontend
            end
        end
        subgraph "Hospital UI Module"
            direction TB
            ShopUI["Hospital UI Module"]:::frontend
            ProtectedRoute["ProtectedRoute"]:::frontend
            subgraph "Shop Contexts"
                direction TB
                HomeCtx["HomeContext"]:::frontend
                DashCtxU["DashboardUserContext"]:::frontend
                ProdDetCtx["ProductDetailsContext"]:::frontend
            end
        end
    end

    %% Backend
    subgraph "Backend (Express API)"
        direction TB
        ServerEntry["server.js"]:::backend
        subgraph "Configuration"
            direction TB
            Env[".env"]:::backend
            DBConfig["db.js"]:::backend
            Keys["keys.js"]:::backend
            UploadScript["uploadFolderCreateScript.js"]:::backend
            UtilFunc["function.js"]:::backend
        end
        AuthMiddleware["auth.js"]:::backend
        subgraph "Controllers"
            direction TB
            AuthCtrl["auth.js"]:::backend
            BraintreeCtrl["braintree.js"]:::backend
            CategoriesCtrl["categories.js"]:::backend
            CustomizeCtrl["customize.js"]:::backend
            OrdersCtrl["orders.js"]:::backend
            ProductsCtrl["products.js"]:::backend
            UsersCtrl["users.js"]:::backend
        end
        subgraph "Routes"
            direction TB
            AuthRoutes["auth.js"]:::backend
            BraintreeRoutes["braintree.js"]:::backend
            CategoryRoutes["categories.js"]:::backend
            CustomizeRoutes["customize.js"]:::backend
            OrderRoutes["orders.js"]:::backend
            ProductRoutes["products.js"]:::backend
            UserRoutes["users.js"]:::backend
        end
        subgraph "Models"
            direction TB
            CategoriesModel["categories.js"]:::backend
            CustomizeModel["customize.js"]:::backend
            OrdersModel["orders.js"]:::backend
            ProductsModel["products.js"]:::backend
            UsersModel["users.js"]:::backend
        end
    end

    %% External Services
    MongoDB["MongoDB Cluster"]:::database
    Braintree["Braintree Gateway"]:::external
    Vercel["Vercel (vercel.json)"]:::external

    %% Connections
    Browser -->|"renders"| App
    Browser -->|"renders"| Index
    App -->|"React Router"| AdminUI
    App -->|"React Router"| ShopUI
    AdminUI -->|"uses"| AdminProtectedRoute
    ShopUI -->|"uses"| ProtectedRoute
    App -->|"Context API"| CatCtx
    App -->|"Context API"| DashCtxA
    App -->|"Context API"| OrderCtxA
    App -->|"Context API"| ProdCtxA
    App -->|"Context API"| HomeCtx
    App -->|"Context API"| DashCtxU
    App -->|"Context API"| ProdDetCtx
    App -->|"HTTP/JSON"| ServerEntry
    ServerEntry -->|"loads"| Env
    ServerEntry -->|"initializes"| DBConfig
    ServerEntry -->|"loads"| Keys
    ServerEntry -->|"executes"| UploadScript
    ServerEntry -->|"registers"| AuthMiddleware
    AuthMiddleware --> Controllers
    Controllers --> Models
    ServerEntry -->|"registers routes"| AuthRoutes
    ServerEntry -->|"registers routes"| BraintreeRoutes
    ServerEntry -->|"registers routes"| CategoryRoutes
    ServerEntry -->|"registers routes"| CustomizeRoutes
    ServerEntry -->|"registers routes"| OrderRoutes
    ServerEntry -->|"registers routes"| ProductRoutes
    ServerEntry -->|"registers routes"| UserRoutes
    Controllers -->|"CRUD"| MongoDB
    Controllers -->|"payment"| Braintree
    Vercel -->|"deploys"| ServerEntry
    Vercel -->|"deploys"| App

    %% Click Events
    click App "https://github.com/kartik-katkar/organease/blob/main/client/src/App.js"
    click Index "https://github.com/kartik-katkar/organease/blob/main/client/src/index.js"
    click AdminUI "https://github.com/kartik-katkar/organease/tree/main/client/src/components/admin"
    click ShopUI "https://github.com/kartik-katkar/organease/tree/main/client/src/components/shop"
    click CatCtx "https://github.com/kartik-katkar/organease/blob/main/client/src/components/admin/categories/CategoryContext.js"
    click DashCtxA "https://github.com/kartik-katkar/organease/blob/main/client/src/components/admin/dashboardAdmin/DashboardContext.js"
    click OrderCtxA "https://github.com/kartik-katkar/organease/blob/main/client/src/components/admin/orders/OrderContext.js"
    click ProdCtxA "https://github.com/kartik-katkar/organease/blob/main/client/src/components/admin/products/ProductContext.js"
    click HomeCtx "https://github.com/kartik-katkar/organease/blob/main/client/src/components/shop/home/HomeContext.js"
    click DashCtxU "https://github.com/kartik-katkar/organease/blob/main/client/src/components/shop/dashboardUser/DashboardUserContext.js"
    click ProdDetCtx "https://github.com/kartik-katkar/organease/blob/main/client/src/components/shop/productDetails/ProductDetailsContext.js"
    click AdminProtectedRoute "https://github.com/kartik-katkar/organease/blob/main/client/src/components/shop/auth/AdminProtectedRoute.js"
    click ProtectedRoute "https://github.com/kartik-katkar/organease/blob/main/client/src/components/shop/auth/ProtectedRoute.js"
    click ServerEntry "https://github.com/kartik-katkar/organease/blob/main/server/server.js"
    click Env "https://github.com/kartik-katkar/organease/blob/main/server/.env"
    click DBConfig "https://github.com/kartik-katkar/organease/blob/main/server/config/db.js"
    click Keys "https://github.com/kartik-katkar/organease/blob/main/server/config/keys.js"
    click UploadScript "https://github.com/kartik-katkar/organease/blob/main/server/config/uploadFolderCreateScript.js"
    click UtilFunc "https://github.com/kartik-katkar/organease/blob/main/server/config/function.js"
    click AuthCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/auth.js"
    click BraintreeCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/braintree.js"
    click CategoriesCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/categories.js"
    click CustomizeCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/customize.js"
    click OrdersCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/orders.js"
    click ProductsCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/products.js"
    click UsersCtrl "https://github.com/kartik-katkar/organease/blob/main/server/controller/users.js"
    click AuthRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/auth.js"
    click BraintreeRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/braintree.js"
    click CategoryRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/categories.js"
    click CustomizeRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/customize.js"
    click OrderRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/orders.js"
    click ProductRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/products.js"
    click UserRoutes "https://github.com/kartik-katkar/organease/blob/main/server/routes/users.js"
    click AuthMiddleware "https://github.com/kartik-katkar/organease/blob/main/server/middleware/auth.js"
    click CategoriesModel "https://github.com/kartik-katkar/organease/blob/main/server/models/categories.js"
    click CustomizeModel "https://github.com/kartik-katkar/organease/blob/main/server/models/customize.js"
    click OrdersModel "https://github.com/kartik-katkar/organease/blob/main/server/models/orders.js"
    click ProductsModel "https://github.com/kartik-katkar/organease/blob/main/server/models/products.js"
    click UsersModel "https://github.com/kartik-katkar/organease/blob/main/server/models/users.js"
    click Vercel "https://github.com/kartik-katkar/organease/blob/main/vercel.json"

    %% Styles
    classDef frontend fill:#D6E8FF,stroke:#0041D0
    classDef backend fill:#D5FFD6,stroke:#08660D
    classDef database fill:#FFE7C4,stroke:#FF9100
    classDef external fill:#F0F0F0,stroke:#888888
```
