# gyanthakur/agriconnect architecture

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

- Interactive diagram: https://gitdiagram.com/gyanthakur/agriconnect
- Repository: https://github.com/gyanthakur/agriconnect

## Overview

##### Project type and purpose
- This is a modern full-stack web application (“Agriconnect”) that provides tailored dashboards and features for two user roles—Farmers and Merchants.
- The front end is a React/Tailwind SPA (built with Vite) and the back end is an Express/MongoDB REST API with file uploads, OTP-based authentication (via Twilio), image handling (via Cloudinary), chat functionality, and order/rental management.

##### File structure
- Top-level: two main folders—`client/` (React code) and `backend/` (Node.js API).
- Frontend directories indicate a component-based UI (components/, pages/, context/, hooks/).
- Backend follows an MVC-style layout:
- config/ – external service configs (MongoDB, Cloudinary)
- controllers/ – business logic per resource (auth, user, crop, equipment, chat, order, rental)
- models/ – Mongoose schemas (user, crop, equipment, order, booking, OTP)
- routes/ – route definitions mapping HTTP endpoints to controllers
- middlewares/ – request validation and JWT/Twilio token handling
- utils/ – JWT helper, OTP helper (Twilio integration), validators
- Shared root-level `package.json` and lockfiles indicate monorepo management.

##### README for insights
- Confirms two authentication flows (Farmers and Merchants).
- Highlights responsive UI, REST API, and separate dashboards.

##### Main components and their interactions
a. Frontend (React SPA)
- Pages & Components: Login/Signup, Home, Services, Dashboards, Shop, Chat, etc.
- State Management: Context API for auth tokens and user roles.
- HTTP Client: Axios or fetch to call backend endpoints.
b. Backend (Express API)
- Routes → Controllers → Models → MongoDB.
- Middleware chain for file uploads (Multer), JWT verification, OTP verification.
- Utils: JWT generation/verification, OTP code generation and Twilio SMS delivery.
c. Database
- MongoDB clusters hosting collections: Users, OTPs, Crops, Equipment, Orders, Rentals, Chats.
d. External Services
- Twilio: send/verify OTP SMS for custom authentication.
- Cloudinary: store and retrieve uploaded images (crops, equipment).
e. Optional: Chat subsystem
- REST endpoints for chat and/or WebSocket server (if implemented separately) linking users to chat documents in MongoDB.

##### Architectural patterns & principles
- Backend: MVC (Models, Views=Controllers, Routes) with middleware pipeline.
- Frontend: component-based UI, container vs. presentational components, hooks for shared logic, context for global state.
- Separation of Concerns: UI, API, Data, and External Services are decoupled.
- Security: JWT-based sessions, role-based access via middleware, OTP via Twilio.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend (Browser)"
        direction TB
        ReactSPA["React SPA"]:::frontend
        subgraph "Auth Pages"
            direction TB
            LoginPage["LoginPage"]:::frontend
            SignupPage["SignupPage"]:::frontend
        end
        subgraph "Dashboards"
            direction TB
            FarmerDashboard["FarmerDashboard"]:::frontend
            MerchantDashboard["MerchantDashboard"]:::frontend
        end
        subgraph "Shop Module"
            direction TB
            CropListing["CropListing"]:::frontend
            CropDetail["CropDetail"]:::frontend
        end
        subgraph "Chat Module"
            direction TB
            ChatPage["ChatPage"]:::frontend
            ChatBot["ChatBot"]:::frontend
        end
        subgraph "State & Utils"
            direction TB
            AppContext["AppContext"]:::frontend
            MerchantContext["MerchantContext"]:::frontend
            AuthUtils["auth.utils.js"]:::frontend
        end
    end

    %% Backend Layer
    subgraph "Backend (Express API)"
        direction TB
        AppJS["app.js"]:::backend
        subgraph "Middlewares"
            direction TB
            VerifyToken["verifyToken.middleware.js"]:::backend
            GetToken["getToken.middleware.js"]:::backend
            Multer["multer.middleware.js"]:::backend
        end
        subgraph "Routes"
            direction TB
            AuthRoutes["auth.routes.js"]:::backend
            UserRoutes["user.routes.js"]:::backend
            CropRoutes["crop.routes.js"]:::backend
            EquipmentRoutes["equipment.routes.js"]:::backend
            OrderRoutes["order.routes.js"]:::backend
            RentalRoutes["rental.routes.js"]:::backend
            ChatRoutes["chat.routes.js"]:::backend
        end
        subgraph "Controllers"
            direction TB
            AuthController["auth.controller.js"]:::backend
            UserController["user.controller.js"]:::backend
            CropController["crop.controller.js"]:::backend
            EquipmentController["equipment.controller.js"]:::backend
            OrderController["order.controller.js"]:::backend
            RentalController["rental.controller.js"]:::backend
            ChatController["chat.controller.js"]:::backend
        end
        subgraph "Models"
            direction TB
            UserModel["user.model.js"]:::backend
            OTPModel["otp.model.js"]:::backend
            CropModel["crop.model.js"]:::backend
            EquipmentModel["equipment.model.js"]:::backend
            OrderModel["order.model.js"]:::backend
            RentalModel["rentalOrder.model.js"]:::backend
            BookingModel["booking.model.js"]:::backend
        end
        subgraph "Utils"
            direction TB
            JWTUtils["jwt.js"]:::backend
            OTPUtils["otpUtils.js"]:::backend
            Validator["validator.js"]:::backend
        end
    end

    %% Database & External Services
    subgraph "Database & External Services"
        direction TB
        MongoDB["MongoDB"]:::external
        Cloudinary["Cloudinary"]:::external
        Twilio["Twilio OTP Service"]:::external
    end

    %% Connections Frontend -> Backend
    ReactSPA -->|"API Calls"| AppJS
    LoginPage -->|"/auth/sendOtp"| AuthRoutes
    SignupPage -->|"/auth/verifyOtp"| AuthRoutes
    FarmerDashboard -->|"/dashboard/data"| UserRoutes
    MerchantDashboard -->|"/dashboard/data"| UserRoutes
    CropListing -->|"/crops"| CropRoutes
    CropDetail -->|"/crops/:id"| CropRoutes
    ChatPage -->|"/chat"| ChatRoutes
    ChatBot -->|"/chat/messages"| ChatRoutes

    %% Middleware Flow
    AuthRoutes -->|requests| VerifyToken
    AuthRoutes -->|file upload| Multer
    AuthRoutes -->|token extraction| GetToken

    %% Routes to Controllers
    AuthRoutes --> AuthController
    UserRoutes --> UserController
    CropRoutes --> CropController
    EquipmentRoutes --> EquipmentController
    OrderRoutes --> OrderController
    RentalRoutes --> RentalController
    ChatRoutes --> ChatController

    %% Controllers to Models & Utils
    AuthController --> OTPModel
    AuthController --> OTPUtils
    AuthController --> JWTUtils
    UserController --> UserModel
    CropController --> CropModel
    EquipmentController --> EquipmentModel
    OrderController --> OrderModel
    RentalController --> RentalModel
    ChatController --> BookingModel

    %% Backend to DB & External
    UserController -->|CRUD| MongoDB
    CropController -->|CRUD| MongoDB
    EquipmentController -->|CRUD| MongoDB
    OrderController -->|CRUD| MongoDB
    RentalController -->|CRUD| MongoDB
    ChatController -->|CRUD| MongoDB
    AuthController -->|send SMS| Twilio
    AuthController -->|upload image| Cloudinary

    %% Click Events
    click ReactSPA "https://github.com/gyanthakur/agriconnect/blob/main/client/src/main.jsx"
    click LoginPage "https://github.com/gyanthakur/agriconnect/blob/main/client/src/pages/LoginPage.jsx"
    click SignupPage "https://github.com/gyanthakur/agriconnect/blob/main/client/src/pages/SignupPage.jsx"
    click CropListing "https://github.com/gyanthakur/agriconnect/blob/main/client/src/pages/shop/CropListing.jsx"
    click CropDetail "https://github.com/gyanthakur/agriconnect/blob/main/client/src/pages/shop/CropDetail.jsx"
    click ChatPage "https://github.com/gyanthakur/agriconnect/blob/main/client/src/pages/ChatPage.jsx"
    click ChatBot "https://github.com/gyanthakur/agriconnect/blob/main/client/src/components/ChatBot.jsx"
    click FarmerDashboard "https://github.com/gyanthakur/agriconnect/blob/main/client/src/components/FarmerDashboard.jsx"
    click MerchantDashboard "https://github.com/gyanthakur/agriconnect/blob/main/client/src/components/MerchantDashboard.jsx"
    click AppContext "https://github.com/gyanthakur/agriconnect/blob/main/client/src/context/AppContext.jsx"
    click MerchantContext "https://github.com/gyanthakur/agriconnect/blob/main/client/src/context/MerchantContext.jsx"
    click AuthUtils "https://github.com/gyanthakur/agriconnect/blob/main/client/src/utils/auth.utils.js"
    click AppJS "https://github.com/gyanthakur/agriconnect/blob/main/backend/app.js"
    click VerifyToken "https://github.com/gyanthakur/agriconnect/blob/main/backend/middlewares/verifyToken.middleware.js"
    click GetToken "https://github.com/gyanthakur/agriconnect/blob/main/backend/middlewares/getToken.middleware.js"
    click Multer "https://github.com/gyanthakur/agriconnect/blob/main/backend/middlewares/multer.middleware.js"
    click AuthRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/auth.routes.js"
    click AuthController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/auth.controller.js"
    click OTPModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/otp.model.js"
    click OTPUtils "https://github.com/gyanthakur/agriconnect/blob/main/backend/utils/otpUtils.js"
    click JWTUtils "https://github.com/gyanthakur/agriconnect/blob/main/backend/utils/jwt.js"
    click UserRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/user.routes.js"
    click UserController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/user.controller.js"
    click UserModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/user.model.js"
    click CropRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/crop.routes.js"
    click CropController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/crop.controller.js"
    click CropModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/crop.model.js"
    click EquipmentRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/equipment.routes.js"
    click EquipmentController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/equipment.controller.js"
    click EquipmentModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/equipment.model.js"
    click OrderRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/order.routes.js"
    click OrderController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/order.controller.js"
    click OrderModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/order.model.js"
    click RentalRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/rental.routes.js"
    click RentalController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/rental.controller.js"
    click RentalModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/rentalOrder.model.js"
    click BookingModel "https://github.com/gyanthakur/agriconnect/blob/main/backend/models/booking.model.js"
    click ChatRoutes "https://github.com/gyanthakur/agriconnect/blob/main/backend/routes/chat.routes.js"
    click ChatController "https://github.com/gyanthakur/agriconnect/blob/main/backend/controllers/chat.controller.js"
    click AppJS "https://github.com/gyanthakur/agriconnect/blob/main/backend/index.js"
    click JWTUtils "https://github.com/gyanthakur/agriconnect/blob/main/backend/utils/jwt.js"
    click Validator "https://github.com/gyanthakur/agriconnect/blob/main/backend/utils/validator.js"

    %% Styles
    classDef frontend fill:#BBDEFB,stroke:#1E88E5,stroke-width:1px
    classDef backend fill:#C8E6C9,stroke:#43A047,stroke-width:1px
    classDef external fill:#FFE0B2,stroke:#FB8C00,stroke-width:1px
```
