# derpinskv2/graphs-remaster architecture

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

- Interactive diagram: https://gitdiagram.com/derpinskv2/graphs-remaster
- Repository: https://github.com/derpinskv2/graphs-remaster

## Overview

##### Main System Components

a) Web Layer:
- Nginx (Reverse Proxy/Load Balancer)
- ASGI Server (Using Uvicorn as indicated by uvicorn_config.py)

b) Application Core:
- Django API Service
- WebSocket Service
- Celery Worker System
- Authentication System (indicated by core/models.py and CustomUser references)

c) Data Processing:
- CSV Data Processing System (evident from data/raw directory)
- Event Processing System
- Background Tasks

##### Component Relationships

a) External Connections:
- Client → Nginx
- Nginx → Django API (HTTP/HTTPS)
- Nginx → WebSocket Service (WS/WSS)

b) Internal Connections:
- Django API → Database
- Celery Workers ↔ Message Broker
- WebSocket Consumers ↔ Clients
- Data Processing Tasks → Celery Queue

##### Specific Implementation Details

a) Services (Rectangles):
- Blue: Django API Service
- Green: WebSocket Service
- Orange: Celery Workers
- Gray: Nginx Proxy

- Database
- Message Broker
- Raw Data Storage (CSV files)

c) Processing Units (Hexagons):
- Data Processing Tasks
- Event Processing
- Background Tasks

##### Key Architectural Patterns to Highlight

- ASGI-based architecture (config/asgi.py)
- REST API structure (core/api and data/api)
- Event-driven processing (event module)
- Task queue system (Celery)
- WebSocket real-time communication

##### Important Subsystems

Detail these specific components:

a) Data Processing Pipeline:
- CSV Data Ingestion
- Data Transformation
- Event Generation

b) API Layer:
- Core API Routes
- Data API Routes
- WebSocket Consumers

c) Authentication/Authorization:
- Custom User Model
- Authentication Flow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client Layer
        Client[Client Applications]
        WebClient[WebSocket Clients]
    end

    subgraph Web Layer
        Nginx["Nginx Reverse Proxy"]:::proxy
        ASGI["ASGI Server (Uvicorn)"]:::server
    end

    subgraph Application Layer
        DjangoAPI["Django API Service"]:::api
        WebSocket["WebSocket Service"]:::websocket
        Auth["Authentication System"]:::auth
        
        subgraph API Routes
            CoreAPI["Core API Routes"]:::api
            DataAPI["Data API Routes"]:::api
        end
    end

    subgraph Processing Layer
        CeleryWorker["Celery Worker System"]:::worker
        DataProcess["CSV Data Processing"]:::process
        EventProcess["Event Processing System"]:::process
        BackgroundTasks["Background Tasks"]:::process
    end

    subgraph Storage Layer
        DB[(Database)]:::storage
        MessageBroker[(Message Broker)]:::storage
        RawData[("Raw Data\nStorage")]:::storage
    end

    %% Connections
    Client --> Nginx
    WebClient --> Nginx
    Nginx --> ASGI
    ASGI --> DjangoAPI
    ASGI --> WebSocket
    DjangoAPI --> Auth
    DjangoAPI --> CoreAPI
    DjangoAPI --> DataAPI
    DjangoAPI --> DB
    WebSocket --> MessageBroker
    CeleryWorker <--> MessageBroker
    DataProcess --> RawData
    DataProcess --> DB
    EventProcess --> MessageBroker
    BackgroundTasks --> DB

    %% Styles
    classDef proxy fill:#gray,stroke:#333,stroke-width:2px
    classDef server fill:#lightblue,stroke:#333,stroke-width:2px
    classDef api fill:#blue,stroke:#333,stroke-width:2px
    classDef websocket fill:#green,stroke:#333,stroke-width:2px
    classDef auth fill:#purple,stroke:#333,stroke-width:2px
    classDef worker fill:#orange,stroke:#333,stroke-width:2px
    classDef process fill:#yellow,stroke:#333,stroke-width:2px
    classDef storage fill:#cyan,stroke:#333,stroke-width:2px

    %% Click Events
    click Nginx "https://github.com/derpinskV2/graphs-remaster/blob/main/nginx/nginx.conf"
    click ASGI "https://github.com/derpinskV2/graphs-remaster/blob/main/api/config/asgi.py"
    click WebSocket "https://github.com/derpinskV2/graphs-remaster/blob/main/api/websocket/consumers.py"
    click CeleryWorker "https://github.com/derpinskV2/graphs-remaster/blob/main/api/config/celery.py"
    click Auth "https://github.com/derpinskV2/graphs-remaster/blob/main/api/core/models.py"
    click DataProcess "https://github.com/derpinskV2/graphs-remaster/blob/main/api/data/tasks.py"
    click EventProcess "https://github.com/derpinskV2/graphs-remaster/blob/main/api/event/tasks.py"
    click CoreAPI "https://github.com/derpinskV2/graphs-remaster/blob/main/api/core/api/router.py"
    click DataAPI "https://github.com/derpinskV2/graphs-remaster/blob/main/api/data/api/router.py"
    click RawData "https://github.com/derpinskV2/graphs-remaster/tree/main/api/data/raw/"
    click DjangoAPI "https://github.com/derpinskV2/graphs-remaster/blob/main/api/config/urls.py"

    %% Legend
    subgraph Legend
        L1[Proxy]:::proxy
        L2[Server]:::server
        L3[API Service]:::api
        L4[WebSocket]:::websocket
        L5[Auth Service]:::auth
        L6[Worker]:::worker
        L7[Process]:::process
        L8[(Storage)]:::storage
    end
```
