# amrmuhamedd/blog-posts architecture

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

- Interactive diagram: https://gitdiagram.com/amrmuhamedd/blog-posts
- Repository: https://github.com/amrmuhamedd/blog-posts

## Overview

##### Component Relationships

a) External Connections:
- Client → API Gateway (REST APIs)
- API Gateway → Cloudinary
- API Gateway → PostgreSQL

b) Internal Module Connections:
- Dependencies between modules (e.g., Posts depend on Users)
- Audit Service's connections to all modules

##### Detailed Component Breakdown

For each major module, include:

a) Core Components:
- Middleware Stack
- Auth Middleware
- Admin Middleware
- Audit Middleware
- Error Middleware
- Upload Middleware

b) Module Structure (for each module):
- Module (e.g., Posts)
- Controller
- Service
- Routes
- DTOs

##### Key Flows to Highlight

a) Authentication Flow:
Client → Auth Middleware → JWT Validation → Route Handler

b) Post Creation Flow:
Client → Upload Middleware → Media Service → Cloudinary
→ Post Service → Database → Audit Service

c) Data Access Flow:
Client → Auth Middleware → Role Check → Service → Prisma → PostgreSQL

- Request → Auth → Admin → Audit → Route → Response

- Error → Error Middleware → Client Response

##### Technical Details

Specifications:

- Node.js Runtime (>18.16.0)
- Express.js Framework
- TypeScript Implementation
- Prisma ORM
- JWT Authentication
- CORS Enabled
- Class Validator
- Jest Testing Framework

##### Deployment Context

A small section showing:
- Docker container boundaries
- Vercel deployment setup
- Environment variable dependencies

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client["Client Layer"]
        REST["REST API Clients"]
        SWAG["Swagger UI"]:::docs
    end

    subgraph Gateway["API Gateway Layer"]
        EXP["Express.js Server"]
        
        subgraph MW["Middleware Stack"]
            direction TB
            AUTH_MW["Auth Middleware"]:::security
            ADMIN_MW["Admin Middleware"]:::security
            AUDIT_MW["Audit Middleware"]:::audit
            ERROR_MW["Error Middleware"]:::error
            UPLOAD_MW["Upload Middleware"]:::upload
        end
    end

    subgraph App["Application Layer"]
        direction TB
        USERS["User Management"]:::module
        POSTS["Posts Management"]:::module
        COMMENTS["Comments System"]:::module
        REACT["Reactions System"]:::module
        CAT["Categories Management"]:::module
        TAGS["Tags Management"]:::module
        MEDIA["Media Management"]:::module
        AUDIT["Audit Management"]:::module
    end

    subgraph Infra["Infrastructure Layer"]
        DB[(PostgreSQL)]:::database
        CLOUD["Cloudinary Storage"]:::external
        PRISMA["Prisma ORM"]:::database
    end

    %% Client Layer Connections
    REST --> EXP
    REST --> SWAG

    %% Middleware Connections
    EXP --> AUTH_MW
    AUTH_MW --> ADMIN_MW
    ADMIN_MW --> AUDIT_MW
    AUDIT_MW --> UPLOAD_MW
    UPLOAD_MW --> ERROR_MW

    %% Module Connections
    ERROR_MW --> USERS
    ERROR_MW --> POSTS
    ERROR_MW --> COMMENTS
    ERROR_MW --> REACT
    ERROR_MW --> CAT
    ERROR_MW --> TAGS
    ERROR_MW --> MEDIA
    ERROR_MW --> AUDIT

    %% Infrastructure Connections
    PRISMA --> DB
    MEDIA --> CLOUD
    USERS --> PRISMA
    POSTS --> PRISMA
    COMMENTS --> PRISMA
    REACT --> PRISMA
    CAT --> PRISMA
    TAGS --> PRISMA
    AUDIT --> PRISMA

    %% Cross-module Dependencies
    POSTS --> USERS
    COMMENTS --> POSTS
    REACT --> POSTS
    POSTS --> CAT
    POSTS --> TAGS
    MEDIA --> POSTS

    %% Click Events
    click AUTH_MW "https://github.com/amrmuhamedd/blog-posts/blob/main/src/core/middleware/auth.middleware.ts"
    click ADMIN_MW "https://github.com/amrmuhamedd/blog-posts/blob/main/src/core/middleware/admin.middleware.ts"
    click AUDIT_MW "https://github.com/amrmuhamedd/blog-posts/blob/main/src/core/middleware/audit.middleware.ts"
    click ERROR_MW "https://github.com/amrmuhamedd/blog-posts/blob/main/src/core/middleware/error.middleware.ts"
    click UPLOAD_MW "https://github.com/amrmuhamedd/blog-posts/blob/main/src/core/middleware/upload.middleware.ts"
    click USERS "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/users/"
    click POSTS "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/posts/"
    click COMMENTS "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/comments/"
    click REACT "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/reactions/"
    click CAT "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/categories/"
    click TAGS "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/tags/"
    click MEDIA "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/media/"
    click AUDIT "https://github.com/amrmuhamedd/blog-posts/tree/main/src/modules/audit/"
    click CLOUD "https://github.com/amrmuhamedd/blog-posts/blob/main/src/config/cloudinary.ts"
    click PRISMA "https://github.com/amrmuhamedd/blog-posts/blob/main/src/core/database/prisma.service.ts"

    %% Styling
    classDef module fill:#ff9900,stroke:#333,stroke-width:2px
    classDef security fill:#ff0000,stroke:#333,stroke-width:2px,color:white
    classDef audit fill:#ffff00,stroke:#333,stroke-width:2px
    classDef error fill:#ff69b4,stroke:#333,stroke-width:2px
    classDef upload fill:#98fb98,stroke:#333,stroke-width:2px
    classDef database fill:#0000ff,stroke:#333,stroke-width:2px,color:white
    classDef external fill:#00ff00,stroke:#333,stroke-width:2px
    classDef docs fill:#800080,stroke:#333,stroke-width:2px,color:white

    %% Legend
    subgraph Legend
        L1["Module"]:::module
        L2["Security"]:::security
        L3["Audit"]:::audit
        L4["Error Handling"]:::error
        L5["Upload"]:::upload
        L6["Database"]:::database
        L7["External Service"]:::external
        L8["Documentation"]:::docs
    end
```
