# veetmoradiya3628/cosketch architecture

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

- Interactive diagram: https://gitdiagram.com/veetmoradiya3628/cosketch
- Repository: https://github.com/veetmoradiya3628/cosketch

## Overview

##### Project type and purpose
- This is a full-stack, real-time, browser-based collaborative whiteboard built on the MERN stack.
- Frontend: React + Redux + Rough.js for drawing, communicates over REST and Socket.IO.
- Backend: Node.js + Express, exposing REST endpoints and Socket.IO events; MongoDB as the data store; JWT-based auth; role-based access; scheduled jobs via a cron utility.

##### Main components
a. Client (Browser)
‑ React application
‑ Redux (whiteboardSlice, cursorSlice)
‑ Rough.js drawing layer
‑ API service module (REST calls to /auth, /boards, /users)
‑ Socket.IO client (socketConn.js)
‑ UI components (Board list, Whiteboard canvas, Modals, Navbar)
b. API Layer (Express Server)
‑ Entry point: server/index.js
‑ Middlewares: authMiddlewares.js (JWT validation), input validation
‑ REST Controllers:
- authController.js (login, registration)
- boardController.js (create/read/update/delete boards)
- boardElementController.js (CRUD on whiteboard elements, export endpoints)
- userController.js (profile, listing)
‑ Routes: authRoutes.js, boardRoutes.js, userRoutes.js
c. Real-time Layer (Socket.IO)
‑ socketHandler.js (initial handshake, join/leave room)
‑ boardDataHandler.js (sync initial board state upon connect)
‑ userSocketDataStore.js (in-memory tracking of active users per board)
d. Persistence Layer
‑ MongoDB collections:
- Users (userModel.js)
- Boards (boardModel.js)
- BoardContents (boardContentModel.js)
‑ Utils: jwtUtils.js (token creation/verification), cronjobs.js (scheduled tasks, e.g., cleanup or archiving)
e. Optional/Support
‑ Swagger UI (swagger.js) for API docs
‑ Static hosting (frontend/public/)
‑ Environment configuration (.env)

##### Interactions and data flows
- On page load, React → REST GET /boards ← Express → MongoDB
- User selects a board → REST GET /boards/:id/content → server retrieves boardContents
- React initializes Socket.IO, emits “join_board” → socketHandler authenticates via JWT → subscribes to a Socket.IO “room”
- As one user draws: React emits “draw_element” event → socketEventHandler receives, updates boardContents in MongoDB, broadcasts “element_added” to other clients
- Cursor movements: React emits “cursor_move” → server broadcasts to other clients via cursorSlice updates
- REST writes (e.g., create board, add member) flow through controllers → models → MongoDB

##### Architectural patterns and design principles
- Layered architecture: UI layer, API/Controller layer, Business logic (handlers, services), Persistence layer
- Event-driven real-time collaboration with Socket.IO
- MVC-style separation on backend (Routes → Controllers → Models)
- Centralized state management on frontend (Redux)
- JWT-based stateless auth for REST; token handshake for web sockets
- Role-based access control within middleware

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Tier
    subgraph "Client Tier"
        direction TB
        EntryClient["frontend/src/index.js"]:::frontend
        ReactApp["React Application"]:::frontend
        WhiteboardSlice["whiteboardSlice"]:::frontend
        CursorSlice["cursorSlice"]:::frontend
        RoughUtils["Rough.js Utilities"]:::frontend
        APIService["API Service (REST)"]:::frontend
        SocketConn["Socket.IO Client"]:::realtime
        BoardItem["Board Item Component"]:::frontend
        Navbar["Navbar Component"]:::frontend
        CreateModal["CreateNewBoard Modal"]:::frontend
        ConfirmModal["ConfirmModal"]:::frontend
        WhiteboardCanvas["Whiteboard Canvas"]:::frontend
        Menu["Whiteboard Menu"]:::frontend

        EntryClient --> ReactApp
        ReactApp --> WhiteboardSlice
        ReactApp --> CursorSlice
        ReactApp --> RoughUtils
        ReactApp --> APIService
        ReactApp --> SocketConn
        ReactApp --> BoardItem
        ReactApp --> Navbar
        ReactApp --> CreateModal
        ReactApp --> ConfirmModal
        ReactApp --> WhiteboardCanvas
        ReactApp --> Menu
    end

    %% API/WebSocket Tier
    subgraph "API/WebSocket Tier"
        direction TB
        EntryAPI["server/index.js"]:::backend
        AuthMiddleware["authMiddlewares.js"]:::backend
        CronJobs["cronjobs.js"]:::util
        JWTUtils["jwtUtils.js"]:::util
        Swagger["swagger.js"]:::backend

        subgraph "Routes"
            direction TB
            AuthRoutes["authRoutes.js"]:::backend
            BoardRoutes["boardRoutes.js"]:::backend
            UserRoutes["userRoutes.js"]:::backend
        end

        subgraph "Controllers"
            direction TB
            AuthController["authController.js"]:::backend
            BoardController["boardController.js"]:::backend
            BoardElementController["boardElementController.js"]:::backend
            UserController["userController.js"]:::backend
        end

        subgraph "Socket.IO Handlers"
            direction TB
            SocketHandler["socketHandler.js"]:::realtime
            EventHandler["socketEventHandler.js"]:::realtime
            BoardDataHandler["boardDataHandler.js"]:::realtime
            UserStore["userSocketDataStore.js"]:::realtime
        end

        EntryAPI --> AuthMiddleware
        EntryAPI --> Swagger
        EntryAPI --> CronJobs
        EntryAPI --> JWTUtils
        EntryAPI --> AuthRoutes
        EntryAPI --> BoardRoutes
        EntryAPI --> UserRoutes
        AuthRoutes --> AuthController
        BoardRoutes --> BoardController
        BoardRoutes --> BoardElementController
        UserRoutes --> UserController
        AuthController -->|uses| JWTUtils
        BoardController --> JWTUtils
        BoardElementController --> JWTUtils
        SocketHandler --> AuthMiddleware
        SocketHandler --> BoardDataHandler
        SocketHandler --> UserStore
        EventHandler --> UserStore
        EventHandler --> BoardElementController
    end

    %% Data Tier
    subgraph "Data Tier"
        direction TB
        Users["Users Collection"]:::database
        Boards["Boards Collection"]:::database
        BoardContents["BoardContents Collection"]:::database
        AuthController --> Users
        BoardController --> Boards
        BoardElementController --> BoardContents
        BoardDataHandler --> BoardContents
    end

    %% Client to API interactions
    APIService -->|"GET /boards"| BoardRoutes
    APIService -->|"POST /auth/login"| AuthRoutes
    APIService -->|"GET /boards/:id/content"| BoardRoutes

    %% Client to WebSocket interactions
    SocketConn -->|"JOIN_BOARD"| SocketHandler
    SocketConn -->|"DRAW_ELEMENT"| EventHandler
    SocketConn -->|"CURSOR_MOVE"| EventHandler
    EventHandler -->|"ELEMENT_ADDED"| SocketConn
    EventHandler -->|"CURSOR_UPDATED"| SocketConn

    %% REST flow inside API
    AuthRoutes -->|"calls"| AuthController
    BoardRoutes -->|"calls"| BoardController
    BoardRoutes -->|"calls"| BoardElementController

    %% Styles
    classDef frontend fill:#D0E6FF,stroke:#1E70BF,color:#000;
    classDef backend fill:#D6F5D6,stroke:#1D8F1D,color:#000;
    classDef realtime fill:#FFE8B3,stroke:#E09E00,color:#000;
    classDef database fill:#E6D6F5,stroke:#6B33A1,color:#000;
    classDef util fill:#F2F2F2,stroke:#999999,color:#000;

    %% Click Events
    click EntryClient "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/index.js"
    click WhiteboardSlice "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/Whiteboard/whiteboardSlice.js"
    click CursorSlice "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/CursorOverlay/cursorSlice.js"
    click RoughUtils "https://github.com/veetmoradiya3628/cosketch/tree/main/frontend/src/components/Whiteboard/utils"
    click APIService "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/services/apiService.js"
    click SocketConn "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/socketConn/socketConn.js"
    click BoardItem "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/BoardItem.js"
    click Navbar "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/Navbar.js"
    click CreateModal "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/CreateNewBoard.js"
    click ConfirmModal "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/ConfirmModal.js"
    click WhiteboardCanvas "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/Whiteboard/Whiteboard.js"
    click Menu "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/components/Whiteboard/Menu.js"
    click EntryAPI "https://github.com/veetmoradiya3628/cosketch/blob/main/server/index.js"
    click AuthMiddleware "https://github.com/veetmoradiya3628/cosketch/blob/main/server/middlewares/authMiddlewares.js"
    click AuthController "https://github.com/veetmoradiya3628/cosketch/blob/main/server/controllers/authController.js"
    click BoardController "https://github.com/veetmoradiya3628/cosketch/blob/main/server/controllers/boardController.js"
    click BoardElementController "https://github.com/veetmoradiya3628/cosketch/blob/main/server/controllers/boardElementController.js"
    click UserController "https://github.com/veetmoradiya3628/cosketch/blob/main/server/controllers/userController.js"
    click AuthRoutes "https://github.com/veetmoradiya3628/cosketch/blob/main/server/routes/authRoutes.js"
    click BoardRoutes "https://github.com/veetmoradiya3628/cosketch/blob/main/server/routes/boardRoutes.js"
    click UserRoutes "https://github.com/veetmoradiya3628/cosketch/blob/main/server/routes/userRoutes.js"
    click SocketHandler "https://github.com/veetmoradiya3628/cosketch/blob/main/server/handler/socketHandler.js"
    click EventHandler "https://github.com/veetmoradiya3628/cosketch/blob/main/server/handler/socketEventHandler.js"
    click BoardDataHandler "https://github.com/veetmoradiya3628/cosketch/blob/main/server/handler/boardDataHandler.js"
    click UserStore "https://github.com/veetmoradiya3628/cosketch/blob/main/server/utils/userSocketDataStore.js"
    click Users "https://github.com/veetmoradiya3628/cosketch/blob/main/server/models/userModel.js"
    click Boards "https://github.com/veetmoradiya3628/cosketch/blob/main/server/models/boardModel.js"
    click BoardContents "https://github.com/veetmoradiya3628/cosketch/blob/main/server/models/boardContentModel.js"
    click JWTUtils "https://github.com/veetmoradiya3628/cosketch/blob/main/server/utils/jwtUtils.js"
    click CronJobs "https://github.com/veetmoradiya3628/cosketch/blob/main/server/utils/cronjobs.js"
    click Swagger "https://github.com/veetmoradiya3628/cosketch/blob/main/server/swagger.js"
    click RoughUtils "https://github.com/veetmoradiya3628/cosketch/tree/main/frontend/src/components/Whiteboard/utils"
    click EntryClient "https://github.com/veetmoradiya3628/cosketch/blob/main/frontend/src/index.js"
```
