# fatimah-mse/task-manager-apis architecture

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

- Interactive diagram: https://gitdiagram.com/fatimah-mse/task-manager-apis
- Repository: https://github.com/fatimah-mse/task-manager-apis

## Overview

##### Project Type and Purpose
- This is a single‐node, monolithic REST API backend for a Team Work Task Management System, built in Node.js/Express with MongoDB (via Mongoose).
- It exposes HTTP(S) endpoints (CRUD for users, projects, tasks, notes, reports, activity logs, messages) and a WebSocket channel (real‐time notifications via socket.io).
- Supports authentication (JWT + argon2), role‐based authorization, input validation, PDF generation, email/OTP, activity logging, and security middlewares.

##### File Structure
- Top level:
- .env, .gitignore, package.json/lock, README.md
- src/
– app.js (configures express app: middlewares, routes)
– server.js (starts HTTP server)
– socket.js (initializes socket.io server & event handlers)
– config/ (emails.js, other env configurations)
– routes/ (activityLog.routes, auth.routes, …)
– controllers/ (one per entity: user, project, task, note, message, report, activityLog)
– models/ (Mongoose schemas for User, Project, Task, Note, Message, OTP, ActivityLog)
– middlewares/ (auth, role checks, access control, validation, rate‐limit, CORS/helmet invoked in app.js)
– helpers/ (PDFTemplates.js, generic helpers)
– validation/ (express-validator schemas)
– fonts/ (assets for PDF generation)

##### README Insights
- Confirms tech stack: Node.js, Express, MongoDB Atlas, Mongoose, JWT, argon2, socket.io, pdfkit, helmet, cors, express‐rate‐limit, express‐validator.
- Outlines entity relationships (users↔projects↔tasks↔notes, messages, activity logs).
- Describes real‐time notifications on task events via socket.io rooms.
- Details PDF export, email/OTP flows, security practices.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Client Tier"
        Client["Web/Mobile Client"]:::external
    end

    subgraph "API Server (Express.js)"
        Server["Server (src/server.js)"]:::api
        App["Express App (src/app.js)"]:::api

        subgraph "HTTP Layer"
            Routes["Routes (src/routes/)"]:::api
            AuthMW["JWT Authentication Middleware"]:::middleware
            RoleMW["Role-based Access Control Middleware"]:::middleware
            ValidateMW["Input Validation Middleware"]:::middleware
            SecMW["Security Middlewares (helmet, cors, rate-limit)"]:::middleware
        end

        subgraph "Business Layer"
            Controllers["Controllers (src/controllers/)"]:::service
            PDFTemplates["PDFTemplates.js"]:::external
            Helpers["Generic Helpers"]:::service
            EmailConfig["Email Config (src/config/emails.js)"]:::external
        end

        subgraph "Real-time Layer"
            Socket["Socket.io Server (src/socket.js)"]:::realtime
        end
    end

    subgraph "Data Layer"
        Models["Mongoose Models (src/models/)"]:::db
        MongoDB["MongoDB Atlas"]:::db
    end

    subgraph "External Services"
        SMTP["SMTP/Email Provider"]:::external
        PDFKit["PDFKit Engine"]:::external
    end

    Client -->|"REST API Calls"| Routes
    Routes --> AuthMW --> RoleMW --> ValidateMW --> SecMW --> Controllers
    Controllers --> Models --> MongoDB
    Controllers -->|"generate PDF"| PDFTemplates
    Controllers -->|"use helpers"| Helpers
    Controllers -->|"send emails/OTP"| EmailConfig
    EmailConfig --> SMTP
    PDFTemplates --> PDFKit
    Server --> App
    App --> Routes
    App --> Socket
    Controllers -->|"emit events"| Socket
    Socket -->|"real-time notifications"| Client

    classDef api fill:#D0E6FF,stroke:#0366d6,color:#0366d6;
    classDef service fill:#E6F4EA,stroke:#28A745,color:#28A745;
    classDef db fill:#E9F5FF,stroke:#005CC5,color:#005CC5;
    classDef middleware fill:#FFF5E6,stroke:#D97706,color:#D97706;
    classDef realtime fill:#FFF0F6,stroke:#C61F7F,color:#C61F7F;
    classDef external fill:#F0F0F0,stroke:#6A737D,color:#6A737D;

    click Server "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/server.js"
    click App "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/app.js"
    click Socket "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/socket.js"
    click EmailConfig "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/config/emails.js"
    click Routes "https://github.com/fatimah-mse/task-manager-apis/tree/main/src/routes/"
    click Controllers "https://github.com/fatimah-mse/task-manager-apis/tree/main/src/controllers/"
    click Models "https://github.com/fatimah-mse/task-manager-apis/tree/main/src/models/"
    click AuthMW "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/middlewares/auth.middleware.js"
    click RoleMW "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/middlewares/role.middleware.js"
    click ValidateMW "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/middlewares/validate.middleware.js"
    click PDFTemplates "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/helpers/PDFTemplates.js"
    click Helpers "https://github.com/fatimah-mse/task-manager-apis/blob/main/src/helpers/helpers.js"
```
