# mishazorin/vps-checker architecture

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

- Interactive diagram: https://gitdiagram.com/mishazorin/vps-checker
- Repository: https://github.com/mishazorin/vps-checker

## Overview

VPS Checker lets users register or log in, save servers, and inspect server health metrics; the frontend also supports linking Telegram. The backend separates authentication, user and server management, and metric collection, with SSH access to monitored machines and PostgreSQL-backed application data. Telegram bot setup and update handlers are present as a separate integration. Some Telegram and metrics wiring is inferred from source references rather than fully shown excerpts, so those relationships are marked unverified.

Main entry points: [`frontend/frontFiles/src/App.tsx`](https://github.com/mishazorin/vps-checker/blob/master/frontend/frontFiles/src/App.tsx) (Dashboard UI), [`backend/src/telegram/telegram-bot.setup.ts`](https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram-bot.setup.ts) (Bot setup), [`backend/src/servers/servers.service.ts`](https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/servers.service.ts) (Server management), [`backend/src/telegram/telegram.update.ts`](https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.update.ts) (Bot handlers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_web["Dashboard UI<br/>[App.tsx]"]
end

subgraph group_api["Backend API"]
  node_auth_api["Auth endpoints<br/>[auth.controller.ts]"]
  node_user_api["User endpoints"]
  node_server_api["Server endpoints"]
  node_metric_api["Metric endpoints"]
  node_telegram_api["Telegram endpoints"]
  node_app_config["Application wiring<br/>[app.module.ts]"]
end

subgraph group_domain["Application services"]
  node_auth_svc["Authentication<br/>[auth.service.ts]"]
  node_user_svc["User management<br/>[users.service.ts]"]
  node_server_svc["Server management<br/>[servers.service.ts]"]
  node_metric_svc["Metric collection<br/>[metrics.service.ts]"]
  node_user_model["User records<br/>[user.entity.ts]"]
  node_server_model["Server records<br/>[server.entity.ts]"]
  node_telegram_svc["Telegram settings"]
end

subgraph group_infra["Storage and integrations"]
  node_postgres[("PostgreSQL")]
  node_ssh_host{{"Monitored servers"}}
  node_bot_setup["Bot setup"]
  node_bot_updates["Bot handlers<br/>[telegram.update.ts]"]
end

node_person(("VPS operator"))
node_telegram{{"Telegram"}}

node_person -->|"uses"| node_web
node_web -->|"authenticates"| node_auth_api
node_web -->|"manages servers"| node_server_api
node_web -->|"requests metrics"| node_metric_api
node_web -->|"requests link"| node_user_api
node_auth_api -->|"delegates to"| node_auth_svc
node_auth_svc -->|"validates users"| node_user_svc
node_user_api -->|"delegates to"| node_user_svc
node_server_api -->|"delegates to"| node_server_svc
node_metric_api -->|"delegates to"| node_metric_svc
node_server_svc -->|"persists records"| node_server_model
node_user_svc -->|"persists users"| node_user_model
node_server_model -->|"belongs to"| node_user_model
node_app_config -->|"configures"| node_postgres
node_server_svc -->|"reads and writes"| node_postgres
node_user_svc -->|"reads and writes"| node_postgres
node_metric_svc -->|"runs commands"| node_ssh_host
node_telegram_api -->|"delegates to"| node_telegram_svc
node_telegram_svc -.->|"stores settings"| node_postgres
node_telegram -.->|"sends updates"| node_bot_setup
node_bot_setup -.->|"dispatches to"| node_bot_updates
node_bot_setup -.->|"uses"| node_server_svc
node_bot_setup -.->|"uses"| node_metric_svc
node_bot_setup -.->|"uses"| node_auth_svc
node_bot_updates -.->|"uses"| node_server_svc
node_bot_updates -.->|"uses"| node_metric_svc
node_bot_updates -.->|"uses"| node_auth_svc

click node_web "https://github.com/mishazorin/vps-checker/blob/master/frontend/frontFiles/src/App.tsx"
click node_auth_api "https://github.com/mishazorin/vps-checker/blob/master/backend/src/auth/auth.controller.ts"
click node_user_api "https://github.com/mishazorin/vps-checker/blob/master/backend/src/users/users.controller.ts"
click node_server_api "https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/servers.controller.ts"
click node_metric_api "https://github.com/mishazorin/vps-checker/blob/master/backend/src/metrics/metrics.controller.ts"
click node_auth_svc "https://github.com/mishazorin/vps-checker/blob/master/backend/src/auth/auth.service.ts"
click node_user_svc "https://github.com/mishazorin/vps-checker/blob/master/backend/src/users/users.service.ts"
click node_server_svc "https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/servers.service.ts"
click node_metric_svc "https://github.com/mishazorin/vps-checker/blob/master/backend/src/metrics/metrics.service.ts"
click node_user_model "https://github.com/mishazorin/vps-checker/blob/master/backend/src/users/entities/user.entity.ts"
click node_server_model "https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/entities/server.entity.ts"
click node_telegram_api "https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.controller.ts"
click node_telegram_svc "https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.service.ts"
click node_bot_setup "https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram-bot.setup.ts"
click node_bot_updates "https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.update.ts"
click node_app_config "https://github.com/mishazorin/vps-checker/blob/master/backend/src/app.module.ts"

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_web toneBlue
class node_auth_api,node_user_api,node_server_api,node_metric_api,node_telegram_api,node_app_config toneAmber
class node_auth_svc,node_user_svc,node_server_svc,node_metric_svc,node_user_model,node_server_model,node_telegram_svc toneMint
class node_postgres,node_ssh_host,node_bot_setup,node_bot_updates toneRose
class node_person,node_telegram toneIndigo
```

## Components

### Web client

- [Dashboard UI](https://github.com/mishazorin/vps-checker/blob/master/frontend/frontFiles/src/App.tsx): `frontend/frontFiles/src/App.tsx`

### Backend API

- [Auth endpoints](https://github.com/mishazorin/vps-checker/blob/master/backend/src/auth/auth.controller.ts): `backend/src/auth/auth.controller.ts`
- [User endpoints](https://github.com/mishazorin/vps-checker/blob/master/backend/src/users/users.controller.ts): `backend/src/users/users.controller.ts`
- [Server endpoints](https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/servers.controller.ts): `backend/src/servers/servers.controller.ts`
- [Metric endpoints](https://github.com/mishazorin/vps-checker/blob/master/backend/src/metrics/metrics.controller.ts): `backend/src/metrics/metrics.controller.ts`
- [Telegram endpoints](https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.controller.ts): `backend/src/telegram/telegram.controller.ts`
- [Application wiring](https://github.com/mishazorin/vps-checker/blob/master/backend/src/app.module.ts): `backend/src/app.module.ts`

### Application services

- [Authentication](https://github.com/mishazorin/vps-checker/blob/master/backend/src/auth/auth.service.ts): `backend/src/auth/auth.service.ts`
- [User management](https://github.com/mishazorin/vps-checker/blob/master/backend/src/users/users.service.ts): `backend/src/users/users.service.ts`
- [Server management](https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/servers.service.ts): `backend/src/servers/servers.service.ts`
- [Metric collection](https://github.com/mishazorin/vps-checker/blob/master/backend/src/metrics/metrics.service.ts): `backend/src/metrics/metrics.service.ts`
- [User records](https://github.com/mishazorin/vps-checker/blob/master/backend/src/users/entities/user.entity.ts): `backend/src/users/entities/user.entity.ts`
- [Server records](https://github.com/mishazorin/vps-checker/blob/master/backend/src/servers/entities/server.entity.ts): `backend/src/servers/entities/server.entity.ts`
- [Telegram settings](https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.service.ts): `backend/src/telegram/telegram.service.ts`

### Storage and integrations

- **PostgreSQL**
- **Monitored servers**
- [Bot setup](https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram-bot.setup.ts): `backend/src/telegram/telegram-bot.setup.ts`
- [Bot handlers](https://github.com/mishazorin/vps-checker/blob/master/backend/src/telegram/telegram.update.ts): `backend/src/telegram/telegram.update.ts`

### Other components

- **VPS operator**
- **Telegram**

## Connections

- VPS operator → Dashboard UI: uses (evidence: `frontend/frontFiles/src/App.tsx`)
- Dashboard UI → Auth endpoints: authenticates (evidence: `frontend/frontFiles/src/App.tsx`)
- Dashboard UI → Server endpoints: manages servers (evidence: `frontend/frontFiles/src/App.tsx`)
- Dashboard UI → Metric endpoints: requests metrics (evidence: `frontend/frontFiles/src/App.tsx`)
- Dashboard UI → User endpoints: requests link (evidence: `frontend/frontFiles/src/App.tsx`)
- Auth endpoints → Authentication: delegates to (evidence: `backend/src/auth/auth.controller.ts`)
- Authentication → User management: validates users (evidence: `backend/src/auth/auth.service.ts`)
- User endpoints → User management: delegates to (evidence: `backend/src/users/users.controller.ts`)
- Server endpoints → Server management: delegates to (evidence: `backend/src/servers/servers.controller.ts`)
- Metric endpoints → Metric collection: delegates to (evidence: `backend/src/metrics/metrics.controller.ts`)
- Server management → Server records: persists records (evidence: `backend/src/servers/servers.service.ts`)
- User management → User records: persists users (evidence: `backend/src/users/users.service.ts`)
- Server records → User records: belongs to (evidence: `backend/src/servers/entities/server.entity.ts`)
- Application wiring → PostgreSQL: configures (evidence: `backend/src/app.module.ts`)
- Server management → PostgreSQL: reads and writes (evidence: `backend/src/servers/servers.service.ts`)
- User management → PostgreSQL: reads and writes (evidence: `backend/src/users/users.service.ts`)
- Metric collection → Monitored servers: runs commands (evidence: `backend/src/metrics/metrics.service.ts`)
- Telegram endpoints → Telegram settings: delegates to (evidence: `backend/src/telegram/telegram.controller.ts`)
- Telegram settings → PostgreSQL: stores settings
- Telegram → Bot setup: sends updates
- Bot setup → Bot handlers: dispatches to
- Bot setup → Server management: uses (evidence: `backend/src/telegram/telegram-bot.setup.ts`)
- Bot setup → Metric collection: uses (evidence: `backend/src/telegram/telegram-bot.setup.ts`)
- Bot setup → Authentication: uses (evidence: `backend/src/telegram/telegram-bot.setup.ts`)
- Bot handlers → Server management: uses (evidence: `backend/src/telegram/telegram.update.ts`)
- Bot handlers → Metric collection: uses (evidence: `backend/src/telegram/telegram.update.ts`)
- Bot handlers → Authentication: uses (evidence: `backend/src/telegram/telegram.update.ts`)
