# velopert/velog architecture

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

- Interactive diagram: https://gitdiagram.com/velopert/velog
- Repository: https://github.com/velopert/velog

## Overview

##### High-Level Architecture Components

a) Frontend Layer (velog-frontend):
- React Application
- Redux Store
- Router System
- Component Library
- API Client

b) Backend Layer (velog-backend):
- API Server (Node.js/Koa)
- Database Models
- Authentication System
- File Handling
- Raw Query Handlers

c) SSR Layer (velog-ssr):
- Server-Side Rendering Service
- Redis Cache
- Route Handlers

##### Infrastructure Components

AWS services as shown in the architecture image:
- AWS Lambda (for API and SSR)
- Database (CockroachDB)
- Redis Cache
- Content Delivery Network
- Storage Service (for images/assets)

##### Component Relationships

a) Data Flow:
- Client → API Gateway → Lambda Functions
- SSR Requests → Lambda → Redis Cache
- API Requests → Database
- File Uploads → Storage Service

b) Authentication Flow:
- Social Login Integration
- Token Management
- Session Handling

##### Detailed Subsystems

a) Post Management:
- Editor System
- Markdown Processing
- Image Upload
- Categories/Tags

b) User System:
- Authentication
- Profiles
- Following System

c) Search & Discovery:
- Search Engine
- Trending Posts
- Tag-based Navigation

##### Additional Details

Technical aspects:

- Redux store structure
- Database schema relationships
- Cache invalidation flows
- API endpoints grouping
- Security layers

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Frontend
        ReactApp["React Application"]:::frontend
        ReduxStore["Redux Store"]:::frontend
        Router["Router System"]:::frontend
        APIClient["API Client"]:::frontend
        PostComponents["Post Components"]:::frontend
        UserComponents["User Components"]:::frontend
        SearchComponents["Search Components"]:::frontend
        AuthComponents["Auth Components"]:::frontend
    end

    subgraph Backend
        APIServer["API Server"]:::backend
        DBModels["Database Models"]:::backend
        AuthSystem["Authentication System"]:::backend
        QueryHandlers["Raw Query Handlers"]:::backend
        PostControllers["Post Controllers"]:::backend
        UserControllers["User Controllers"]:::backend
        SearchAPI["Search API"]:::backend
        AuthControllers["Auth Controllers"]:::backend
    end

    subgraph SSR
        SSRService["SSR Service"]:::ssr
        RedisCache["Redis Cache"]:::cache
        RouteHandlers["Route Handlers"]:::ssr
    end

    subgraph Infrastructure
        Lambda["AWS Lambda"]:::aws
        DB[(CockroachDB)]:::db
        CDN["Content Delivery Network"]:::aws
        Storage["Storage Service"]:::aws
    end

    %% Frontend Relationships
    ReactApp --> ReduxStore
    ReactApp --> Router
    ReactApp --> APIClient
    ReactApp --> PostComponents
    ReactApp --> UserComponents
    ReactApp --> SearchComponents
    ReactApp --> AuthComponents

    %% Backend Relationships
    APIServer --> DBModels
    APIServer --> AuthSystem
    APIServer --> QueryHandlers
    APIServer --> PostControllers
    APIServer --> UserControllers
    APIServer --> SearchAPI
    APIServer --> AuthControllers

    %% SSR Relationships
    SSRService --> RedisCache
    SSRService --> RouteHandlers
    SSRService --> APIServer

    %% Infrastructure Relationships
    APIClient --> Lambda
    Lambda --> APIServer
    APIServer --> DB
    APIServer --> Storage
    ReactApp --> CDN
    CDN --> Storage

    %% Click Events
    click ReactApp "https://github.com/velopert/velog/blob/master/velog-frontend/src/Root.js"
    click ReduxStore "https://github.com/velopert/velog/blob/master/velog-frontend/src/store/configure.js"
    click Router "https://github.com/velopert/velog/blob/master/velog-frontend/src/routeConfig.js"
    click APIClient "https://github.com/velopert/velog/tree/master/velog-frontend/src/lib/api/"
    click APIServer "https://github.com/velopert/velog/blob/master/velog-backend/src/api.js"
    click DBModels "https://github.com/velopert/velog/tree/master/velog-backend/src/database/models/"
    click AuthSystem "https://github.com/velopert/velog/blob/master/velog-backend/src/lib/middlewares/authToken.js"
    click QueryHandlers "https://github.com/velopert/velog/tree/master/velog-backend/src/database/rawQuery/"
    click SSRService "https://github.com/velopert/velog/blob/master/velog-ssr/src/ssr/index.ts"
    click RedisCache "https://github.com/velopert/velog/blob/master/velog-ssr/src/lib/redisClient.ts"
    click RouteHandlers "https://github.com/velopert/velog/blob/master/velog-ssr/src/router/index.ts"
    click PostControllers "https://github.com/velopert/velog/tree/master/velog-backend/src/router/posts/"
    click PostComponents "https://github.com/velopert/velog/tree/master/velog-frontend/src/components/post/"
    click UserControllers "https://github.com/velopert/velog/tree/master/velog-backend/src/router/users/"
    click UserComponents "https://github.com/velopert/velog/tree/master/velog-frontend/src/components/user/"
    click SearchAPI "https://github.com/velopert/velog/blob/master/velog-backend/src/database/rawQuery/search.js"
    click SearchComponents "https://github.com/velopert/velog/tree/master/velog-frontend/src/components/search/"
    click AuthControllers "https://github.com/velopert/velog/tree/master/velog-backend/src/router/auth/"
    click AuthComponents "https://github.com/velopert/velog/tree/master/velog-frontend/src/components/landing/AuthForm/"

    %% Styling
    classDef frontend fill:#3498db,stroke:#2980b9,color:#fff
    classDef backend fill:#2ecc71,stroke:#27ae60,color:#fff
    classDef ssr fill:#e74c3c,stroke:#c0392b,color:#fff
    classDef aws fill:#f1c40f,stroke:#f39c12,color:#fff
    classDef db fill:#9b59b6,stroke:#8e44ad,color:#fff
    classDef cache fill:#e67e22,stroke:#d35400,color:#fff
```
