# sakshikukreja04/supplylink architecture

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

- Interactive diagram: https://gitdiagram.com/sakshikukreja04/supplylink
- Repository: https://github.com/sakshikukreja04/supplylink

## Overview

##### Project Type and Purpose
- SupplyLink is a full-stack MERN (MongoDB, Express, React, Node.js) application.
- It connects vendors with suppliers for raw-materials procurement, offering real-time updates, location-based filtering, voice search, order management, payment integration, and reviews.

##### High-Level File Structure Analysis
- Top-level:
- client/ → React + TypeScript front-end
- server/ → Node.js + Express back-end
- client/src: UI components, pages, contexts (Auth, Socket), hooks, utilities, Firebase integration.
- server: controllers (business logic), routes (REST API), models (Mongoose schemas), middleware, services (e.g., keyword extraction, translation), setup (websocket, database, Firebase Admin), utils.

##### Key Architecture Insights from README
- Front-end: React 18, Vite, Tailwind CSS, Leaflet (maps), Web Speech API, Socket.IO client, Firebase Auth.
- Back-end: Express.js, MongoDB/Mongoose, Socket.IO server, Firebase Admin SDK, OpenStreetMap proxy, Razorpay integration for payments.

a. Client-side
- Browser (React SPA)
- Voice Search Module (Web Speech API)
- Module (Leaflet + OpenStreetMap)
- Socket.IO Client
- Firebase Auth SDK
b. Server-side
- Express REST API
- Socket.IO Server
- Controllers & Services (search, order, review, geocoding, payment)
- Middleware (auth, CORS, token verification)
- Mongoose Models (User, Supplier, Vendor, Order, Review, etc.)
- Firebase Admin SDK
- OpenStreetMap Proxy Service
- Razorpay Payment Gateway
c. Database
- MongoDB Cluster (Atlas or local)
d. External Services
- Firebase Authentication
- OpenStreetMap Nominatim (geocoding)
- Razorpay (payment)

##### Relationships and Data Flows
- User actions in Browser → React components invoke REST API (HTTP)
- Socket.IO handshake over WebSocket for real-time events (order updates, notifications)
- REST API calls → Express routes → Controllers → MongoDB via Mongoose
- Authentication: React uses Firebase Auth SDK → issues ID Token → sent in HTTP headers → server verifies via Firebase Admin SDK
- Geocoding: server forwards /api/geocode requests to OpenStreetMap → returns coordinates
- Payment: on order payment, server calls Razorpay API → processes transaction → updates Order model → emits Socket.IO event back to client
- Database updates trigger notifications via Socket.IO to relevant clients

##### Architectural Patterns & Design Principles
- Layered (Presentation → API Layer → Business Logic → Data Access)
- MVC-style separation: routes → controllers → models
- Event-driven communication with Socket.IO
- Single Page Application (SPA) on front-end, micro-module components
- Role-based access: vendor vs supplier, enforced via protected routes & middleware
- Third-party integration via adapter/service modules

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Front-end Layer
    subgraph "Front-end" 
        direction TB
        ReactSPA["React SPA"]:::frontend
        VoiceSearch["Voice Search Module"]:::frontend
        MapModule["Map Module"]:::frontend
        SocketClient["Socket.IO Client"]:::frontend
        FirebaseAuthClient["Firebase Auth SDK"]:::frontend
    end

    %% Back-end Layer
    subgraph "Back-end"
        direction TB
        ExpressAPI["Express REST API"]:::backend
        SocketServer["Socket.IO Server"]:::backend
        ControllersServices["Controllers & Services"]:::backend
        Middleware["Middleware"]:::backend
        Models["Mongoose Models"]:::backend
        FirebaseAdmin["Firebase Admin SDK"]:::backend
        GeocodingProxy["OpenStreetMap Proxy Service"]:::backend
        RazorpayService["Razorpay Payment Integration"]:::backend
        MongoConfig["MongoDB Config"]:::backend
    end

    %% Database Layer
    subgraph "Database"
        direction TB
        MongoDB["MongoDB Cluster"]:::db
    end

    %% External Services
    subgraph "External Services"
        direction TB
        FirebaseExt["Firebase Authentication"]:::external
        OSM["OpenStreetMap Nominatim"]:::external
        RazorpayExt["Razorpay"]:::external
    end

    %% Connections: HTTP calls
    ReactSPA -->|"HTTP REST"| ExpressAPI
    VoiceSearch -->|"invoke API"| ExpressAPI
    MapModule -->|"invoke API"| ExpressAPI
    FirebaseAuthClient -->|"Auth Token"| ExpressAPI

    %% WebSocket events
    ReactSPA -.->|"WebSocket"| SocketServer
    SocketClient -.->|"WebSocket"| SocketServer

    %% Back-end internal flows
    ExpressAPI -->|"routes"| ControllersServices
    ControllersServices -->|"access"| Models
    ControllersServices -->|"use"| Middleware
    ControllersServices -->|"uses"| FirebaseAdmin
    ControllersServices -->|"calls"| GeocodingProxy
    ControllersServices -->|"calls"| RazorpayService
    ControllersServices -->|"reads/writes"| MongoDB
    MongoConfig -->|"configures"| MongoDB

    SocketServer -->|"emit/listen"| ReactSPA
    SocketServer -->|"updates"| ControllersServices

    %% External calls
    FirebaseAdmin -.->|"verify token"| FirebaseExt
    GeocodingProxy -.->|"HTTP"| OSM
    RazorpayService -.->|"HTTP"| RazorpayExt

    %% Click Events
    click ReactSPA "https://github.com/sakshikukreja04/supplylink/blob/main/client/src/main.tsx"
    click VoiceSearch "https://github.com/sakshikukreja04/supplylink/blob/main/client/src/components/VoiceSearch.tsx"
    click MapModule "https://github.com/sakshikukreja04/supplylink/blob/main/client/src/components/NearbySuppliersMap.tsx"
    click SocketClient "https://github.com/sakshikukreja04/supplylink/blob/main/client/src/contexts/SocketContext.tsx"
    click FirebaseAuthClient "https://github.com/sakshikukreja04/supplylink/blob/main/client/src/firebase/auth.ts"
    click ExpressAPI "https://github.com/sakshikukreja04/supplylink/blob/main/server/server.js"
    click SocketServer "https://github.com/sakshikukreja04/supplylink/blob/main/server/websocketServer.js"
    click Middleware "https://github.com/sakshikukreja04/supplylink/blob/main/server/middleware/auth.js"
    click Models "https://github.com/sakshikukreja04/supplylink/blob/main/server/models/User.js"
    click FirebaseAdmin "https://github.com/sakshikukreja04/supplylink/blob/main/server/config/firebaseAdmin.js"
    click GeocodingProxy "https://github.com/sakshikukreja04/supplylink/blob/main/server/controllers/geocodingController.js"
    click RazorpayService "https://github.com/sakshikukreja04/supplylink/blob/main/server/config/razorpay.js"
    click MongoConfig "https://github.com/sakshikukreja04/supplylink/blob/main/server/config/mongodb.js"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366d6,color:#0366d6
    classDef backend fill:#DFF2BF,stroke:#4F8A10,color:#4F8A10
    classDef db fill:#FFEFD5,stroke:#FF8C00,color:#FF8C00
    classDef external fill:#F2F2F2,stroke:#666666,color:#666666
```
