# gnu-connect/server-node architecture

> Architecture diagram of the GitHub repository gnu-connect/server-node, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gnu-connect/server-node
- Repository: https://github.com/gnu-connect/server-node

## Overview

##### Project type and purpose
- This is a backend service built with NestJS (Node.js + TypeScript) that powers a KakaoTalk chatbot for Gyeongsang National University students.
- It exposes HTTP endpoints consumed by the Kakao i Open Builder frontend, scrapes external university systems for notices, dining menus, academic calendars, and library seat data, and persists results in a relational database and object storage.

##### File structure
- Top-level folders and files
- Dockerfile, docker-compose.yml/dev: container definitions for local/dev and production environments.
- .github/workflows/ci-cd pipeline.yml: CI/CD automation.
- src/
– api/common: shared decorators, DTOs, filters, interceptors, utilities.
– api/internal: health-check module.
– api/public: feature modules (campuses, colleges, departments, message-templates, reading-rooms, users) each following NestJS’s controller → service → module pattern.
– type-orm: database module, entity definitions, custom repositories.
– main.ts & instrument.ts: application bootstrap and telemetry setup.
- test/: end-to-end tests.
- Configuration files for ESLint, Prettier, TypeScript, Nest CLI, PNPM lock.

##### README for additional insights
- Technology stack includes NestJS, TypeORM (PostgreSQL), Redis (caching), Supabase Storage (for screenshots), Docker, GCP, Sentry for monitoring.

##### Details
- Essential modules (common, internal, public) and their interactions.
- Surface cross-cutting concerns like logging/monitoring and environment configuration.
- Don’t omit background jobs or caching layers—they’re critical to system behavior.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Frontend
    KI["Kakao i Open Builder"]:::ext

    %% NestJS Application Boundary
    subgraph "NestJS Application"
        direction TB
        Main["Application Entry\nsrc/main.ts\nsrc/app.module.ts"]:::api
        Common["Common Module"]:::api
        subgraph "↳ Common Components"
            SentryFilter["Sentry Filter"]:::api
            SentryInterceptor["Sentry Interceptor"]:::api
        end
        subgraph "Internal Modules"
            HealthCtrl["HealthCheck Controller"]:::api
            HealthModule["HealthCheck Module"]:::api
        end
        subgraph "Public Feature Modules"
            CampusesModule["Campuses Module"]:::api
            CollegesModule["Colleges Module"]:::api
            DepartmentsModule["Departments Module"]:::api
            MessagesModule["MessageTemplates Module"]:::api
            ReadingRoomsModule["ReadingRooms Module"]:::api
            UsersModule["Users Module"]:::api
        end
        Instrumentation["Telemetry & Instrumentation"]:::api
        Scheduler["Scheduled Scraper (Cron)"]:::api
    end

    %% Data Stores
    DB["PostgreSQL Database"]:::db
    Redis["Redis Cache"]:::db
    Storage["Supabase Storage"]:::db

    %% External Services
    Websites["University Websites"]:::ext
    Sentry["Sentry Monitoring"]:::ext

    %% Infrastructure
    CI["CI/CD Pipeline\n.github/workflows/ci-cd-pipeline.yml"]:::infra
    Docker["Docker & Compose"]:::infra

    %% Relationships
    KI -->|"HTTP Requests"| Main
    Main --> Common
    Main --> HealthModule
    HealthModule --> HealthCtrl
    Main --> CampusesModule
    Main --> CollegesModule
    Main --> DepartmentsModule
    Main --> MessagesModule
    Main --> ReadingRoomsModule
    Main --> UsersModule
    Main --> Instrumentation
    Main --> Scheduler

    %% Feature Flows
    CampusesModule -->|"uses Service → Repo"| DB
    CollegesModule -->|"uses Service → Repo"| DB
    DepartmentsModule -->|"uses Service → Repo"| DB
    MessagesModule -->|"uses Service → Repo"| DB
    ReadingRoomsModule -->|"uses Service → Repo"| DB
    UsersModule -->|"uses Service → Repo"| DB

    %% Caching
    CampusesModule -->|"cache lookup"| Redis
    CollegesModule -->|"cache lookup"| Redis
    DepartmentsModule -->|"cache lookup"| Redis
    ReadingRoomsModule -->|"cache lookup"| Redis
    UsersModule -->|"cache lookup"| Redis

    %% Scheduler
    Scheduler -->|"scrapes"| Websites
    Scheduler -->|"stores screenshots"| Storage
    Scheduler -->|"updates"| DB

    %% Monitoring
    Instrumentation --> Sentry

    %% Infrastructure flows
    CI --> Docker
    Docker --> Main

    %% Click Events
    click Main "https://github.com/gnu-connect/server-node/blob/main/src/main.ts"
    click Common "https://github.com/gnu-connect/server-node/tree/main/src/api/common/"
    click SentryFilter "https://github.com/gnu-connect/server-node/blob/main/src/api/common/filters/sentry.filter.ts"
    click SentryInterceptor "https://github.com/gnu-connect/server-node/blob/main/src/api/common/interceptors/sentry.interceptor.ts"
    click HealthModule "https://github.com/gnu-connect/server-node/blob/main/src/api/internal/health/health.module.ts"
    click HealthCtrl "https://github.com/gnu-connect/server-node/blob/main/src/api/internal/health/health.controller.ts"
    click CampusesModule "https://github.com/gnu-connect/server-node/blob/main/src/api/public/campuses/campuses.module.ts"
    click CollegesModule "https://github.com/gnu-connect/server-node/blob/main/src/api/public/colleges/colleges.module.ts"
    click DepartmentsModule "https://github.com/gnu-connect/server-node/blob/main/src/api/public/departments/departments.module.ts"
    click MessagesModule "https://github.com/gnu-connect/server-node/blob/main/src/api/public/message-templates/messages.module.ts"
    click ReadingRoomsModule "https://github.com/gnu-connect/server-node/blob/main/src/api/public/reading-rooms/reading-rooms.module.ts"
    click UsersModule "https://github.com/gnu-connect/server-node/blob/main/src/api/public/users/users.module.ts"
    click CI "https://github.com/gnu-connect/server-node/blob/main/.github/workflows/ci-cd pipeline.yml"
    click Docker "https://github.com/gnu-connect/server-node/tree/main/Dockerfile"
    click Docker "https://github.com/gnu-connect/server-node/blob/main/Dockerfile.dev"
    click Docker "https://github.com/gnu-connect/server-node/blob/main/docker-compose.yml"
    click Docker "https://github.com/gnu-connect/server-node/blob/main/docker-compose-dev.yml"

    %% Styles
    classDef api fill:#D0E8FF,stroke:#0366d6,stroke-width:1px;
    classDef db fill:#E6F4EA,stroke:#28A745,stroke-width:1px;
    classDef ext fill:#FFE8D0,stroke:#D15704,stroke-width:1px;
    classDef infra fill:#E2E2E2,stroke:#6A737D,stroke-width:1px;
```
