# jigar-sable/instagram-mern architecture

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

- Interactive diagram: https://gitdiagram.com/jigar-sable/instagram-mern
- Repository: https://github.com/jigar-sable/instagram-mern

## Overview

##### Project Type & Purpose
- This is a full-stack Instagram clone built with the MERN stack (MongoDB, Express, React, Node.js), augmented by Socket.IO for real-time chat, AWS S3/Cloudinary for image storage, and SendGrid for emails.
- Frontend is a React+Redux SPA, backend is an Express API with REST endpoints and a WebSocket server for messaging.

##### Core Components
a. Frontend (React/Redux)
- React components under `frontend/src/components`
- State management via Redux (`frontend/src/store.js`, actions, reducers)
- Routing via React-Router (`frontend/src/Routes`)
- UI via TailwindCSS + MUI
b. Backend (Node.js/Express)
- Server entry: `backend/app.js` (imported by `server.js`)
- Config & middleware: JWT auth, error handling, async wrapper
- Controllers & Routes: user, post, message, chat
- Utilities: AWS S3 or Cloudinary upload functions, SendGrid email, cookie helper
c. Database
- MongoDB collections for Users, Posts, Chats, Messages (Mongoose models)
d. Real-time Layer
- Socket.IO integrated in backend; clients connect from React to receive/send chat events
e. External Services
- AWS S3 or Cloudinary for image storage
- SendGrid for transactional email (password reset)
f. Deployment
- Frontend deployed on Vercel
- Backend packaged via Procfile (Heroku) or Vercel serverless functions
- Environment variables in `backend/config/config.env.example`, `vercel.json`

##### Relationships & Data Flows
- Browser ↔ React SPA (UI/UX)
- React components dispatch Redux actions → API calls (HTTP) to Express endpoints → Controllers → MongoDB → back to client via JSON
- React initiates a Socket.IO connection to Express server for real-time chat events
- File uploads by client → signed/resigned to AWS S3 or Cloudinary via backend → storage URL stored in MongoDB
- Password reset/email flows via backend → SendGrid

##### Architectural Patterns & Principles
- Separation of concerns: UI layer, state layer (Redux), API layer, data layer (MongoDB)
- RESTful API design for CRUD operations
- WebSocket pub/sub pattern for messaging
- Middleware chain in Express for auth, error handling, async
- CI/CD / environment-based configs

##### Detailed Checklist
- Database: MongoDB Atlas (with Mongoose models)
- Storage: AWS S3 / Cloudinary
- Mail: SendGrid
- Deployment annotations: Vercel, Heroku (Procfile), vercel.json

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Client (Browser/React App)"
        comp["React Components"]:::frontend
        store["Redux Store"]:::frontend
        actions["Redux Actions"]:::frontend
        reducers["Redux Reducers"]:::frontend
        routes["React Router"]:::frontend
        configTailwind["TailwindCSS + MUI"]:::frontend
        entry["Entry Point (frontend/src/index.js)"]:::frontend
    end

    subgraph "API Server (Node.js + Express)"
        serverApp["Express App (backend/app.js)"]:::backend
        bootstrapServer["Server Bootstrap w/ Socket.IO (server.js)"]:::backend
        socketIO["Socket.IO Server"]:::backend

        subgraph Routes
            userRoute["User Routes"]:::backend
            postRoute["Post Routes"]:::backend
            chatRoute["Chat Routes"]:::backend
            msgRoute["Message Routes"]:::backend
        end

        subgraph Controllers
            userCtrl["User Controller"]:::backend
            postCtrl["Post Controller"]:::backend
            chatCtrl["Chat Controller"]:::backend
            msgCtrl["Message Controller"]:::backend
        end

        subgraph Middlewares
            auth["Auth Middleware"]:::backend
            asyncWrap["Async Wrapper"]:::backend
            errHandler["Error Handler"]:::backend
        end

        subgraph Utils
            aws["AWS S3/Cloudinary Functions"]:::backend
            emailUtil["SendGrid Email Utility"]:::backend
            cookieUtil["Cookie Helper"]:::backend
            errUtil["Error Utility"]:::backend
        end
    end

    subgraph Database
        userModel["User Model"]:::db
        postModel["Post Model"]:::db
        chatModel["Chat Model"]:::db
        msgModel["Message Model"]:::db
    end

    awsS3["AWS S3 / Cloudinary"]:::external
    sendGrid["SendGrid"]:::external

    deployFront["Vercel (frontend)"]:::external
    vercelCfg["Vercel Config"]:::external
    procfile["Heroku Procfile"]:::external

    %% Connections
    entry -->|"HTTP: GET/POST JSON"| serverApp
    entry -->|"Socket.IO: chat message"| socketIO

    serverApp -->|connect to DB| userModel
    serverApp --> auth
    serverApp --> asyncWrap
    serverApp --> errHandler
    serverApp --> userRoute
    serverApp --> postRoute
    serverApp --> chatRoute
    serverApp --> msgRoute
    serverApp --> socketIO

    userRoute --> userCtrl
    postRoute --> postCtrl
    chatRoute --> chatCtrl
    msgRoute --> msgCtrl

    userCtrl --> userModel
    postCtrl --> postModel
    chatCtrl --> chatModel
    msgCtrl --> msgModel

    userCtrl --> emailUtil
    userCtrl --> cookieUtil
    postCtrl --> aws
    postCtrl --> errUtil

    aws --> userModel
    emailUtil --> sendGrid

    %% Deployment
    entry --> deployFront
    deployFront --> vercelCfg
    bootstrapServer --> procfile

    %% Click Events
    click comp "https://github.com/jigar-sable/instagram-mern/tree/main/frontend/src/components"
    click store "https://github.com/jigar-sable/instagram-mern/blob/main/frontend/src/store.js"
    click actions "https://github.com/jigar-sable/instagram-mern/tree/main/frontend/src/actions"
    click reducers "https://github.com/jigar-sable/instagram-mern/tree/main/frontend/src/reducers"
    click routes "https://github.com/jigar-sable/instagram-mern/tree/main/frontend/src/Routes"
    click configTailwind "https://github.com/jigar-sable/instagram-mern/blob/main/frontend/tailwind.config.js"
    click entry "https://github.com/jigar-sable/instagram-mern/blob/main/frontend/src/index.js"
    click serverApp "https://github.com/jigar-sable/instagram-mern/blob/main/backend/app.js"
    click bootstrapServer "https://github.com/jigar-sable/instagram-mern/blob/main/server.js"
    click auth "https://github.com/jigar-sable/instagram-mern/blob/main/backend/middlewares/auth.js"
    click asyncWrap "https://github.com/jigar-sable/instagram-mern/blob/main/backend/middlewares/catchAsync.js"
    click errHandler "https://github.com/jigar-sable/instagram-mern/blob/main/backend/middlewares/error.js"
    click userRoute "https://github.com/jigar-sable/instagram-mern/blob/main/backend/routes/userRoute.js"
    click postRoute "https://github.com/jigar-sable/instagram-mern/blob/main/backend/routes/postRoute.js"
    click chatRoute "https://github.com/jigar-sable/instagram-mern/blob/main/backend/routes/chatRoute.js"
    click msgRoute "https://github.com/jigar-sable/instagram-mern/blob/main/backend/routes/messageRoute.js"
    click userCtrl "https://github.com/jigar-sable/instagram-mern/blob/main/backend/controllers/userController.js"
    click postCtrl "https://github.com/jigar-sable/instagram-mern/blob/main/backend/controllers/postController.js"
    click chatCtrl "https://github.com/jigar-sable/instagram-mern/blob/main/backend/controllers/chatController.js"
    click msgCtrl "https://github.com/jigar-sable/instagram-mern/blob/main/backend/controllers/messageController.js"
    click aws "https://github.com/jigar-sable/instagram-mern/blob/main/backend/utils/awsFunctions.js"
    click emailUtil "https://github.com/jigar-sable/instagram-mern/blob/main/backend/utils/sendEmail.js"
    click cookieUtil "https://github.com/jigar-sable/instagram-mern/blob/main/backend/utils/sendCookie.js"
    click errUtil "https://github.com/jigar-sable/instagram-mern/blob/main/backend/utils/errorHandler.js"
    click userModel "https://github.com/jigar-sable/instagram-mern/blob/main/backend/models/userModel.js"
    click postModel "https://github.com/jigar-sable/instagram-mern/blob/main/backend/models/postModel.js"
    click chatModel "https://github.com/jigar-sable/instagram-mern/blob/main/backend/models/chatModel.js"
    click msgModel "https://github.com/jigar-sable/instagram-mern/blob/main/backend/models/messageModel.js"
    click deployFront "https://github.com/jigar-sable/instagram-mern/tree/main/frontend/build"
    click vercelCfg "https://github.com/jigar-sable/instagram-mern/blob/main/vercel.json"
    click procfile "https://github.com/jigar-sable/instagram-mern/tree/main/Procfile"

    %% Styles
    classDef frontend fill:#D6EAF8,stroke:#21618C,stroke-width:1px
    classDef backend fill:#D5F5E3,stroke:#1D8348,stroke-width:1px
    classDef external fill:#FDEBD0,stroke:#B9770E,stroke-width:1px
    classDef db fill:#F9EBEA,stroke:#922B21,stroke-width:1px
```
