# f1lrotto/igorbot architecture

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

- Interactive diagram: https://gitdiagram.com/f1lrotto/igorbot
- Repository: https://github.com/f1lrotto/igorbot

## Overview

##### Main Components

A. Discord Integration Layer
- Discord Bot Service (src/services/discordBot.js)
- Discord Webhook Service (src/services/discordWebhook.js)
- Command Handler System (src/commands/*)

B. Data Layer
- MongoDB Database
- Multiple MongoDB Models:
- Server Configuration
- Articles
- Formula
- Morning News
- Train Information
- User Data

C. Controller Layer
- Main Controller
- Formula Controller
- Morning Report Controller
- News Controller
- News Feed Controller
- Train Controller

D. Services Layer
- Message Distributor
- News Scraper (SME Scraper)
- Command Deployment Service

E. View Layer
- Handlebars Templates

##### Component Relationships

- Discord Bot → Command Handler → Controllers
- Controllers ↔ MongoDB Models
- News Scraper → News Controller → MongoDB
- Message Distributor → Discord Webhook
- Controllers → View Layer (Handlebars)

**┌─ External Services ─┐    ┌─ Application Core ─┐    ┌─ Data Layer ─┐**
- Discord          │    │ - Controllers      │    │ - MongoDB    │
- News Sources     │ → │ - Services         │ → │ - Models     │
- ┘    └──────────────────┘    └─────────────┘

##### Data Flow Indicators

Key flows:
- News Scraping Flow: News Source → Scraper → Controller → Database
- Command Processing Flow: Discord → Bot → Command Handler → Controller → Database
- Morning Report Flow: Database → Controller → Message Distributor → Discord Webhook

##### Additional Elements

Components in a separate section:
- Configuration Management
- Command Deployment Process
- Template Rendering System

Key Recommendations:

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External
        Discord[Discord Platform]
        NewsSources[News Sources]
    end

    subgraph Integration
        DiscordBot["Discord Bot Service"]:::service
        DiscordWebhook["Discord Webhook Service"]:::service
        CommandHandler["Command Handler System"]:::service
    end

    subgraph Controllers
        MainCtrl["Main Controller"]:::controller
        FormulaCtrl["Formula Controller"]:::controller
        MorningCtrl["Morning Report Controller"]:::controller
        NewsCtrl["News Controller"]:::controller
        NewsFeedCtrl["News Feed Controller"]:::controller
        TrainCtrl["Train Controller"]:::controller
    end

    subgraph Services
        MessageDist["Message Distributor"]:::service
        NewsScraper["News Scraper"]:::service
        CmdDeploy["Command Deployment Service"]:::service
        MongoService["MongoDB Service"]:::service
    end

    subgraph Data
        MongoDB[(MongoDB)]:::database
        subgraph Models
            ServerConfig["Server Config Model"]:::model
            Articles["Articles Model"]:::model
            Formula["Formula Model"]:::model
            MorningNews["Morning News Model"]:::model
            Train["Train Model"]:::model
            User["User Model"]:::model
        end
    end

    subgraph Views
        Templates["Handlebars Templates"]:::view
    end

    %% External to Integration
    Discord --> DiscordBot
    Discord --> DiscordWebhook
    NewsSources --> NewsScraper

    %% Integration Layer Flow
    DiscordBot --> CommandHandler
    CommandHandler --> MainCtrl

    %% Controller to Service Flow
    NewsCtrl --> MessageDist
    NewsFeedCtrl --> MessageDist
    MorningCtrl --> MessageDist
    MessageDist --> DiscordWebhook

    %% Data Flow
    MongoService --> MongoDB
    Controllers --> MongoService
    Models --> MongoDB

    %% Service Layer Connections
    NewsScraper --> NewsCtrl
    CmdDeploy --> CommandHandler

    %% View Layer
    Controllers --> Templates

    %% Click Events
    click DiscordBot "https://github.com/f1lrotto/IgorBot/blob/main/src/services/discordBot.js"
    click DiscordWebhook "https://github.com/f1lrotto/IgorBot/blob/main/src/services/discordWebhook.js"
    click CommandHandler "https://github.com/f1lrotto/IgorBot/tree/main/src/commands/"
    click MongoService "https://github.com/f1lrotto/IgorBot/blob/main/src/services/mongo.js"
    click ServerConfig "https://github.com/f1lrotto/IgorBot/blob/main/src/models/ServerConfig.js"
    click Articles "https://github.com/f1lrotto/IgorBot/blob/main/src/models/articles.mongo.js"
    click Formula "https://github.com/f1lrotto/IgorBot/blob/main/src/models/formula.mongo.js"
    click MorningNews "https://github.com/f1lrotto/IgorBot/blob/main/src/models/morningNews.mongo.js"
    click Train "https://github.com/f1lrotto/IgorBot/blob/main/src/models/train.mongo.js"
    click User "https://github.com/f1lrotto/IgorBot/blob/main/src/models/user.mongo.js"
    click MainCtrl "https://github.com/f1lrotto/IgorBot/blob/main/src/controller/mainController.js"
    click FormulaCtrl "https://github.com/f1lrotto/IgorBot/blob/main/src/controller/formulaController.js"
    click MorningCtrl "https://github.com/f1lrotto/IgorBot/blob/main/src/controller/morningReportController.js"
    click NewsCtrl "https://github.com/f1lrotto/IgorBot/blob/main/src/controller/newsController.js"
    click NewsFeedCtrl "https://github.com/f1lrotto/IgorBot/blob/main/src/controller/newsFeedController.js"
    click TrainCtrl "https://github.com/f1lrotto/IgorBot/blob/main/src/controller/trainController.js"
    click MessageDist "https://github.com/f1lrotto/IgorBot/blob/main/src/services/messageDistributor.js"
    click NewsScraper "https://github.com/f1lrotto/IgorBot/blob/main/src/newsScraper/smeScraper.js"
    click CmdDeploy "https://github.com/f1lrotto/IgorBot/blob/main/src/services/deploy-commands.js"
    click Templates "https://github.com/f1lrotto/IgorBot/blob/main/src/views/layouts/main.handlebars"

    classDef default fill:#fff,stroke:#333,stroke-width:2px;
    classDef service fill:#b8d4ff,stroke:#333;
    classDef controller fill:#98FF98,stroke:#333;
    classDef model fill:#FFE5B4,stroke:#333;
    classDef database fill:#FF9999,stroke:#333;
    classDef view fill:#DDA0DD,stroke:#333;

    %% Legend
    subgraph Legend
        L1["Service"]:::service
        L2["Controller"]:::controller
        L3["Model"]:::model
        L4["Database"]:::database
        L5["View"]:::view
    end
```
