# varun-chakraborty/blog-post architecture

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

- Interactive diagram: https://gitdiagram.com/varun-chakraborty/blog-post
- Repository: https://github.com/varun-chakraborty/blog-post

## Overview

##### Project Type and Purpose
- This is a full-stack blogging platform (“Blog Post App”) with:
- A React/TypeScript SPA (frontend)
- A Node.js/Express/TypeScript API (backend)
- Persistent storage via PostgreSQL (managed through Prisma)
- In-memory caching/session store via Redis
- Real-time chat via Socket.IO

##### Top-Level Components
a. Frontend (frontend/)
- Built with Vite + React + TypeScript + Tailwind CSS
- Core pieces:
- App shell (src/main.tsx → App.tsx)
- Pages (src/pages/*)
- UI components, forms, cards, buttons (src/components/*)
- State management (src/redux/*)
- HTTP services (src/services/http/*)
- WebSocket client (src/services/socket)
b. Backend (backend/)
- Node.js + Express + TypeScript
- Dockerized (Dockerfile + docker-compose.yml)
- Key subcomponents:
- HTTP server entrypoint (src/server.ts + src/index.ts)
- Routing layer (src/router/v1.route/*)
- Controllers (src/controllers/*)
- Database layer (Prisma ORM in src/db/prisma.ts)
- Caching/session layer (Redis in src/db/redis.ts)
- Middleware (auth checks, user resolution)
- Socket.IO server (src/socket + src/socketListenerHandlers)
- Utility modules (token utils, response wrapper, cookie setter)
c. Datastores
- PostgreSQL (Prisma migrations + schema.prisma)
- Redis (session, token blacklisting, pub/sub for notifications)
d. External Infrastructure
- Docker / Docker Compose for local dev
- Vercel (frontend deployment via vercel.json)
- CI pipeline (GitHub Actions: .github/workflows/ci.yml)
- Sonar for code quality (sonar-project.properties)

##### Component Interactions & Data Flows
1. Browser → React SPA (served via Vite/hosted on CDN)
2. SPA → HTTP API
- REST calls to /api/v1/auth, /posts, /comments, /users, etc.
- HTTP flows through Express router → middleware → controllers → Prisma → Postgres
3. SPA ↔ WebSocket
- Real-time message events via Socket.IO client/server
- socketListenerHandlers handle events like “newMessage” and broadcast via Redis pub/sub if clustered
4. API → Redis
- Store/retrieve access & refresh tokens
- Invalidate tokens on sign-out
- Possibly pub/sub for real-time notifications
5. API → Postgres
- Prisma client issues queries (CRUD for posts, comments, likes, follows)

##### Architectural Patterns & Principles
- Layered architecture:
- Presentation → Routing → Controllers → Data Access (Prisma) → Database
- Cross-cutting concerns handled by middleware (authentication, authorization)
- Separation of concerns: HTTP vs. WebSocket vs. DB vs. Cache
- Twelve-factor app principles (environment config via .env.sample, 12-factor logging, etc.)
- Containerization: encapsulate backend dependencies in Docker images

1. Client Layer (Browser / Mobile)
2. CDN / Static Hosting (serving SPA assets)
3. Backend Services
4. Datastores & Caches
- HTTP API Service (Express)
- Real-time Service (Socket.IO)
- Browser → CDN → SPA → HTTP API
- SPA ↔ Socket.IO endpoint
- HTTP API → Middleware → Controllers → Prisma Client → Postgres
- HTTP API → Redis
- Socket.IO → Redis Pub/Sub (if applicable)
d. Component with technologies:
- React + Vite + Tailwind (frontend)
- Express + TypeScript + Jest (backend tests)
- Prisma + PostgreSQL
- Redis
- Docker + Docker-Compose
e. Environment overlays:
- Docker Compose orchestrating API, Postgres, Redis in dev
- CI/CD pipeline invoking tests & deployments (GitHub Actions → Vercel)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client Layer"
        Browser["Browser"]:::client
    end

    %% CDN / Static Hosting
    subgraph "CDN / Static Hosting"
        CDN["CDN / Static Hosting"]:::infra
    end

    %% Frontend Application
    subgraph "Frontend Application"
        direction TB
        AppShell["App Shell"]:::client
        Pages["Pages"]:::client
        UI["UI Components"]:::client
        Redux["State Management"]:::client
        HTTPSvc["HTTP Services"]:::client
        WSClient["WebSocket Client"]:::client
    end

    %% Backend Services
    subgraph "Backend Services"
        direction TB
        subgraph "HTTP API Service"
            HTTPAPI["Express HTTP API"]:::service
            Middleware["Middleware<br/>(Auth/AuthZ)"]:::service
            Router["Routing Layer"]:::service
            Controllers["Controllers"]:::service
            Prisma["Prisma Client"]:::service
            RedisCache["Redis Cache/Session"]:::service
            Utils["Utility Modules"]:::service
        end
        subgraph "Real-time Service"
            SocketServer["Socket.IO Server"]:::service
            EventHandlers["Socket Event Handlers"]:::service
        end
    end

    %% Datastores & Caches
    subgraph "Datastores & Caches"
        Postgres["PostgreSQL<br/>Schema & Migrations"]:::db
        RedisDB["Redis"]:::db
    end

    %% Infrastructure & CI/CD
    subgraph "Infrastructure & CI/CD"
        DockerCompose["Docker Compose"]:::infra
        CI["CI/CD Pipeline"]:::infra
    end

    %% Connections
    Browser --> CDN
    CDN --> AppShell
    AppShell --> HTTPAPI
    AppShell --> SocketServer
    HTTPAPI --> Middleware --> Router --> Controllers --> Prisma --> Postgres
    HTTPAPI --> RedisDB
    SocketServer --> RedisDB
    DockerCompose --> HTTPAPI
    DockerCompose --> Postgres
    DockerCompose --> RedisDB
    CI --> CDN
    CI --> DockerCompose

    %% Click Events
    click AppShell "https://github.com/varun-chakraborty/blog-post/blob/main/frontend/src/main.tsx"
    click Pages "https://github.com/varun-chakraborty/blog-post/tree/main/frontend/src/pages/"
    click UI "https://github.com/varun-chakraborty/blog-post/tree/main/frontend/src/components/"
    click Redux "https://github.com/varun-chakraborty/blog-post/tree/main/frontend/src/redux/"
    click HTTPSvc "https://github.com/varun-chakraborty/blog-post/tree/main/frontend/src/services/http/"
    click WSClient "https://github.com/varun-chakraborty/blog-post/blob/main/frontend/src/services/socket/index.ts"
    click HTTPAPI "https://github.com/varun-chakraborty/blog-post/blob/main/backend/src/index.ts"
    click Router "https://github.com/varun-chakraborty/blog-post/tree/main/backend/src/router/v1.route/"
    click Controllers "https://github.com/varun-chakraborty/blog-post/tree/main/backend/src/controllers/"
    click Prisma "https://github.com/varun-chakraborty/blog-post/blob/main/backend/src/db/prisma.ts"
    click RedisCache "https://github.com/varun-chakraborty/blog-post/blob/main/backend/src/db/redis.ts"
    click Middleware "https://github.com/varun-chakraborty/blog-post/tree/main/backend/src/middlewares/"
    click SocketServer "https://github.com/varun-chakraborty/blog-post/blob/main/backend/src/socket/index.ts"
    click EventHandlers "https://github.com/varun-chakraborty/blog-post/tree/main/backend/src/socketListenerHandlers/"
    click Utils "https://github.com/varun-chakraborty/blog-post/tree/main/backend/src/utils/"
    click Postgres "https://github.com/varun-chakraborty/blog-post/blob/main/backend/prisma/schema.prisma"
    click DockerCompose "https://github.com/varun-chakraborty/blog-post/blob/main/backend/docker-compose.yml"
    click DockerCompose "https://github.com/varun-chakraborty/blog-post/blob/main/backend/docker-compose.dev.yml"
    click CI "https://github.com/varun-chakraborty/blog-post/blob/main/.github/workflows/ci.yml"
    click CI "https://github.com/varun-chakraborty/blog-post/blob/main/frontend/vercel.json"
    click CI "https://github.com/varun-chakraborty/blog-post/blob/main/sonar-project.properties"

    %% Styles
    classDef client fill:#a0d8f1,stroke:#333,stroke-width:1px
    classDef service fill:#a8e6a3,stroke:#333,stroke-width:1px
    classDef db fill:#f5c26b,stroke:#333,stroke-width:1px
    classDef infra fill:#e0e0e0,stroke:#333,stroke-width:1px
```
