# karinapakholkova/oop-2024-1 architecture

> Architecture diagram of the GitHub repository karinapakholkova/oop-2024-1, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/karinapakholkova/oop-2024-1
- Repository: https://github.com/karinapakholkova/oop-2024-1

## Overview

This is a Telegram news-aggregator bot. Users request latest or category news, save articles, and view or delete saved items; they can also subscribe to category mailings. Bot routes updates to actions, while the API fetches news and database components persist likes and mailing subscriptions. The README documents basic commands and hourly mailing; the sampled scheduler currently runs every 10 seconds. Mailing-list database wiring is supported by the mailing-list excerpt and source index; unsampled command internals are not inferred beyond documented capabilities.

Main entry points: [`src/main/java/project/Bot.java`](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Bot.java) (Update router), [`src/main/java/project/MailingList/MailingList.java`](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/MailingList/MailingList.java) (Mailing scheduler), [`src/main/java/project/commands/LatestNewsAction.java`](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/LatestNewsAction.java) (Latest news action), [`src/main/java/project/commands/CategoryNewsAction.java`](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/CategoryNewsAction.java) (Category news action)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_telegram["Telegram bot"]
  node_bot["Update router<br/>[Bot.java]"]
  node_command_registry["Basic commands"]
  node_base_commands["Command responses"]
  node_keyboard["News keyboard<br/>[Keyboard.java]"]
  node_main["Application startup<br/>[Main.java]"]
end

subgraph group_news["News delivery"]
  node_news_api["News API client<br/>[Api.java]"]
  node_latest_action["Latest news action"]
  node_category_action["Category news action"]
  node_format_news["News formatter<br/>[CreateString.java]"]
end

subgraph group_saved["Saved news"]
  node_liked_action["Saved news action"]
  node_news_database["Liked-news manager"]
  node_db_connection[("PostgreSQL connection")]
end

subgraph group_mailing["Category mailings"]
  node_mailing_action["Mailing controls"]
  node_mailing_scheduler["Mailing scheduler<br/>[MailingList.java]"]
  node_mailing_database["Subscription manager"]
end

node_user(("Telegram user"))
node_telegram_platform{{"Telegram"}}
node_news_service{{"NewsAPI service"}}

node_user -->|"sends updates"| node_bot
node_bot -->|"sends replies"| node_telegram_platform
node_bot -->|"routes requests"| node_latest_action
node_bot -->|"routes requests"| node_category_action
node_bot -->|"routes requests"| node_liked_action
node_bot -->|"routes requests"| node_mailing_action
node_bot -->|"looks up commands"| node_command_registry
node_command_registry -->|"delegates responses"| node_base_commands
node_latest_action -->|"fetches headlines"| node_news_api
node_category_action -->|"fetches category"| node_news_api
node_category_action -->|"formats results"| node_format_news
node_news_api -->|"requests articles"| node_news_service
node_latest_action -->|"saves selected news"| node_news_database
node_liked_action -->|"reads and deletes"| node_news_database
node_news_database -->|"opens connection"| node_db_connection
node_mailing_scheduler -->|"reads subscriptions"| node_mailing_database
node_mailing_scheduler -->|"formats category news"| node_format_news
node_mailing_scheduler -->|"sends scheduled messages"| node_bot
node_mailing_action -.->|"manages subscriptions"| node_mailing_database
node_main -->|"starts bot"| node_bot
node_main -->|"starts scheduler"| node_mailing_scheduler

click node_bot "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Bot.java"
click node_command_registry "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/ListOfCommands.java"
click node_base_commands "https://github.com/karinapakholkova/oop-2024-1/tree/main/src/main/java/project/baseCommand"
click node_keyboard "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Keyboard.java"
click node_news_api "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/API/Api.java"
click node_latest_action "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/LatestNewsAction.java"
click node_category_action "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/CategoryNewsAction.java"
click node_format_news "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/auxiliaryFunctions/CreateString.java"
click node_liked_action "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/LikedNewsAction.java"
click node_news_database "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/database/DatabaseManager.java"
click node_db_connection "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/database/DataBaseConnection.java"
click node_mailing_action "https://github.com/karinapakholkova/oop-2024-1/tree/main/src/main/java/project/commands"
click node_mailing_scheduler "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/MailingList/MailingList.java"
click node_mailing_database "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/database/BDForMailingList.java"
click node_main "https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Main.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_bot,node_command_registry,node_base_commands,node_keyboard,node_main,node_user toneBlue
class node_news_api,node_latest_action,node_category_action,node_format_news toneAmber
class node_liked_action,node_news_database,node_db_connection,node_news_service toneMint
class node_mailing_action,node_mailing_scheduler,node_mailing_database toneRose
class node_telegram_platform toneIndigo
```

## Components

### Telegram bot

- [Update router](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Bot.java): `src/main/java/project/Bot.java`
- [Basic commands](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/ListOfCommands.java): `src/main/java/project/ListOfCommands.java`
- [Command responses](https://github.com/karinapakholkova/oop-2024-1/tree/main/src/main/java/project/baseCommand): `src/main/java/project/baseCommand`
- [News keyboard](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Keyboard.java): `src/main/java/project/Keyboard.java`
- [Application startup](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/Main.java): `src/main/java/project/Main.java`

### News delivery

- [News API client](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/API/Api.java): `src/main/java/project/API/Api.java`
- [Latest news action](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/LatestNewsAction.java): `src/main/java/project/commands/LatestNewsAction.java`
- [Category news action](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/CategoryNewsAction.java): `src/main/java/project/commands/CategoryNewsAction.java`
- [News formatter](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/auxiliaryFunctions/CreateString.java): `src/main/java/project/auxiliaryFunctions/CreateString.java`

### Saved news

- [Saved news action](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/commands/LikedNewsAction.java): `src/main/java/project/commands/LikedNewsAction.java`
- [Liked-news manager](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/database/DatabaseManager.java): `src/main/java/project/database/DatabaseManager.java`
- [PostgreSQL connection](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/database/DataBaseConnection.java): `src/main/java/project/database/DataBaseConnection.java`

### Category mailings

- [Mailing controls](https://github.com/karinapakholkova/oop-2024-1/tree/main/src/main/java/project/commands): `src/main/java/project/commands`
- [Mailing scheduler](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/MailingList/MailingList.java): `src/main/java/project/MailingList/MailingList.java`
- [Subscription manager](https://github.com/karinapakholkova/oop-2024-1/blob/main/src/main/java/project/database/BDForMailingList.java): `src/main/java/project/database/BDForMailingList.java`

### Other components

- **Telegram user**
- **Telegram**
- **NewsAPI service**

## Connections

- Telegram user → Update router: sends updates (evidence: `src/main/java/project/Bot.java`)
- Update router → Telegram: sends replies (evidence: `src/main/java/project/Bot.java`)
- Update router → Latest news action: routes requests (evidence: `src/main/java/project/Bot.java`)
- Update router → Category news action: routes requests (evidence: `src/main/java/project/Bot.java`)
- Update router → Saved news action: routes requests (evidence: `src/main/java/project/Bot.java`)
- Update router → Mailing controls: routes requests (evidence: `src/main/java/project/Bot.java`)
- Update router → Basic commands: looks up commands (evidence: `src/main/java/project/Bot.java`)
- Basic commands → Command responses: delegates responses (evidence: `src/main/java/project/ListOfCommands.java`)
- Latest news action → News API client: fetches headlines (evidence: `src/main/java/project/commands/LatestNewsAction.java`)
- Category news action → News API client: fetches category (evidence: `src/main/java/project/commands/CategoryNewsAction.java`)
- Category news action → News formatter: formats results (evidence: `src/main/java/project/commands/CategoryNewsAction.java`)
- News API client → NewsAPI service: requests articles (evidence: `src/main/java/project/API/Api.java`)
- Latest news action → Liked-news manager: saves selected news (evidence: `src/main/java/project/commands/LatestNewsAction.java`)
- Saved news action → Liked-news manager: reads and deletes (evidence: `src/main/java/project/commands/LikedNewsAction.java`)
- Liked-news manager → PostgreSQL connection: opens connection (evidence: `src/main/java/project/database/DatabaseManager.java`)
- Mailing scheduler → Subscription manager: reads subscriptions (evidence: `src/main/java/project/MailingList/MailingList.java`)
- Mailing scheduler → News formatter: formats category news (evidence: `src/main/java/project/MailingList/MailingList.java`)
- Mailing scheduler → Update router: sends scheduled messages (evidence: `src/main/java/project/MailingList/MailingList.java`)
- Mailing controls → Subscription manager: manages subscriptions (evidence: `src/main/java/project/commands/DeleteMailingListAction.java`)
- Application startup → Update router: starts bot (evidence: `src/main/java/project/Main.java`)
- Application startup → Mailing scheduler: starts scheduler (evidence: `src/main/java/project/Main.java`)
