# mohamediliasskaddar/imk-monitors architecture

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

- Interactive diagram: https://gitdiagram.com/mohamediliasskaddar/imk-monitors
- Repository: https://github.com/mohamediliasskaddar/imk-monitors

## Overview

##### Project type and purpose
- IMK-Monitors is a full-stack web application (MEAN-style) for automated uptime monitoring of websites.
- Frontend: Angular standalone components, Bootstrap 5, ngx-translate.
- Backend: Node.js + Express, MongoDB (Mongoose), JWT authentication, cron-driven checks, nodemailer alerts.

##### File structure
- Top-level:
- backend/ (Express server, routes, models, middleware, monitor.js)
- frontend/ (Angular app, standalone components, services, assets for i18n & styling)
- backend/models contain Mongoose schemas (User, Site, Log, Config).
- backend/routes expose REST endpoints (auth, user, site, log, config).
- backend/monitor.js holds the cron job that reads Config → polls sites → writes Log → triggers alerts.
- frontend/src/app/pages maps to feature modules (login, register, dashboard, add-website, user-sites, admin-sites, sites-status, users-list, profile).
- frontend/src/app/services encapsulate API calls (auth.service, user.service, site.service).
- frontend/src/app/shared contains Navbar and Sidebar.
- Angular uses Router (app.routes.ts) and global config files.

##### README insights
- JWT-protected routes enforce roles (User vs. Admin).
- Global check interval stored in MongoDB Config collection and can be updated at runtime.
- Cron job invoked server-side (node-cron).
- Alerts via nodemailer (email/SMS placeholder).

##### Main components & relationships
a. Components
- Client Browser
- Angular Frontend
- Presentation Layer (Pages + Shared UI components)
- Services Layer (AuthService, SiteService, UserService)
- REST API (Express Server)
- Routes/Controllers (auth, user, site, log, config)
- Middleware (auth_mdw)
- Business Logic / monitor.js cron job
- Database (MongoDB)
- Collections: users, sites, logs, configs
- External Services
- Email/SMS provider (via nodemailer / Amazon SNS stub)
b. Interactions
1. User actions in browser → Angular components → call AuthService/SiteService/etc.
2. HTTP(S) requests → Express routes → Mongoose models → MongoDB read/write → response to frontend.
3. Cron job (node-cron) periodically executes monitor.js → fetch sites from DB → perform HTTP checks → write logs to DB → if failure threshold → send email/SMS.
4. Admin updates check interval via frontend → configRoute updates Config document → cron job picks up new interval without restart.
c. Architectural patterns
- Layered MVC-style backend (Express Controllers → Mongoose Models → Cron as a service).
- Angular standalone component architecture with Router and Services (separation of Presentation & Data layers).
- Token-based authentication (JWT) with role-based access in middleware.
- Configuration driven cron scheduling.
d. Technologies & frameworks
- Angular 15+ (Standalone Components, Router, ngx-translate)
- Bootstrap 5 for UI, CSS variables for theming (dark/light)
- Node.js + Express.js for REST API
- Mongoose ODM for MongoDB
- jsonwebtoken + bcrypt for auth
- node-cron for scheduling
- nodemailer for alerts

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    Browser["Client Browser"]:::frontend

    subgraph "Angular Frontend"
        UI["Pages/UI Components"]:::frontend
        Shared["Shared UI Components"]:::frontend
        AuthS["AuthService"]:::frontend
        UserS["UserService"]:::frontend
        SiteS["SiteService"]:::frontend
        Router["Router Configuration"]:::frontend
        ConfClient["app.config.ts"]:::frontend
        ConfServer["app.config.server.ts"]:::frontend
    end

    Browser -->|interacts with| UI
    UI -->|uses| AuthS
    UI -->|uses| UserS
    UI -->|uses| SiteS
    UI -->|routes via| Router
    UI -->|reads| ConfClient
    UI -->|reads| ConfServer

    AuthS -->|"HTTP/JSON"| API
    UserS -->|"HTTP/JSON"| API
    SiteS -->|"HTTP/JSON"| API

    %% Backend Layer
    subgraph "Express API"
        API["server.js"]:::backend
        subgraph "Routes/Controllers"
            RTAuth["auth.js"]:::backend
            RTUser["userRoute.js"]:::backend
            RTSite["siteRoute.js"]:::backend
            RTLog["logRoute.js"]:::backend
            RTConfig["configRoute.js"]:::backend
        end
        MW["auth_mdw.js"]:::backend
        EmailSvc["emailService.js"]:::backend
        Cron["monitor.js (Cron Service)"]:::backend
        subgraph "Mongoose Models"
            MU["User.js"]:::backend
            MS["Site.js"]:::backend
            ML["Log.js"]:::backend
            MC["Config.js"]:::backend
        end
    end

    API --> RTAuth
    API --> RTUser
    API --> RTSite
    API --> RTLog
    API --> RTConfig
    RTAuth -->|JWT verify| MW
    RTAuth -->|access| MU
    RTUser -->|access| MU
    RTSite -->|access| MS
    RTLog -->|access| ML
    RTConfig -->|access| MC
    MW -->|protects routes| RTAuth
    RTAuth -->|update/read| MU
    RTUser -->|update/read| MU
    RTSite -->|create/read| MS
    RTLog -->|write/read| ML
    RTConfig -->|update/read| MC

    %% Cron Job interactions
    Cron -.->|scheduled| Cron
    Cron -->|fetch sites| MS
    Cron -->|write logs| ML
    MC -->|interval config| Cron
    Cron -->|send alert| Ext

    %% Database
    DB["MongoDB<br/>users, sites, logs, configs"]:::db
    MU --> DB
    MS --> DB
    ML --> DB
    MC --> DB

    %% External Service
    Ext["Email/SMS Service"]:::external

    %% Connections to External
    EmailSvc -->|send email/SMS| Ext

    %% Click Events
    click UI "https://github.com/mohamediliasskaddar/imk-monitors/tree/master/frontend/src/app/pages/"
    click Shared "https://github.com/mohamediliasskaddar/imk-monitors/tree/master/frontend/src/app/shared/"
    click AuthS "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/frontend/src/app/services/auth.service.ts"
    click UserS "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/frontend/src/app/services/user.service.ts"
    click SiteS "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/frontend/src/app/services/site.service.ts"
    click Router "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/frontend/src/app/app.routes.ts"
    click ConfClient "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/frontend/src/app/app.config.ts"
    click ConfServer "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/frontend/src/app/app.config.server.ts"
    click API "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/server.js"
    click RTAuth "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/routes/auth.js"
    click RTUser "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/routes/userRoute.js"
    click RTSite "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/routes/siteRoute.js"
    click RTLog "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/routes/logRoute.js"
    click RTConfig "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/routes/configRoute.js"
    click MW "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/middleware/auth_mdw.js"
    click EmailSvc "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/emailService.js"
    click Cron "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/monitor.js"
    click MU "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/models/User.js"
    click MS "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/models/Site.js"
    click ML "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/models/Log.js"
    click MC "https://github.com/mohamediliasskaddar/imk-monitors/blob/master/backend/models/Config.js"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#006064,color:#000;
    classDef backend fill:#E8F5E9,stroke:#2E7D32,color:#000;
    classDef db fill:#FFF3E0,stroke:#EF6C00,color:#000;
    classDef external fill:#ECEFF1,stroke:#546E7A,color:#000
```
