# dhruvjain01/notifyhub architecture

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

- Interactive diagram: https://gitdiagram.com/dhruvjain01/notifyhub
- Repository: https://github.com/dhruvjain01/notifyhub

## Overview

NotifyHub is a multi-tenant email notification platform with a React admin dashboard and a Spring backend. The principal workflow is: an application submits a notification, the backend persists it, background scheduling dispatches it, the engine renders a versioned template and selects an email provider, then records delivery or retry status for tracking. The dashboard also supports authentication, application/key management, template administration, metrics, audit logs, and an interactive API playground. The graph uses sampled source and README evidence; some dashboard-to-endpoint wiring and unsampled capabilities are documented but not independently verified.

Main entry points: [`backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java`](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java) (Delivery engine), [`backend/src/main/java/com/notifyhub/notification/service/NotificationService.java`](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/service/NotificationService.java) (Submission service), [`backend/src/main/java/com/notifyhub/notification/entity/Notification.java`](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/entity/Notification.java) (Notification records), [`backend/src/main/java/com/notifyhub/template/service/TemplateService.java`](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/service/TemplateService.java) (Template management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_dashboard["Admin dashboard"]
  node_dashboardui["Dashboard UI<br/>[App.tsx]"]
  node_playground["API playground<br/>[PlaygroundPage.tsx]"]
  node_frontendapi["Dashboard API client<br/>[client.ts]"]
  node_auditui["Audit log view<br/>[AuditLogsPage.tsx]"]
  node_metricsui["Metrics dashboard<br/>[DashboardPage.tsx]"]
end

subgraph group_access["Identity and tenants"]
  node_authapi["Authentication API"]
  node_authservice["Authentication service<br/>[AuthService.java]"]
  node_userstore[("Users and tokens<br/>[User.java]")]
end

subgraph group_management["Platform management"]
  node_appadmin["Application management"]
  node_appstore[("Application records<br/>[Application.java]")]
  node_templateadmin["Template management"]
  node_templatestore[("Template versions<br/>[Template.java]")]
end

subgraph group_delivery["Notification delivery"]
  node_notificationapi["Notification API"]
  node_batchapi["Batch API"]
  node_notificationservice["Submission service"]
  node_notificationstore[("Notification records<br/>[Notification.java]")]
  node_scheduler["Background scheduler"]
  node_engine["Delivery engine"]
  node_renderer["Template renderer"]
  node_providers["Email providers"]
end

subgraph group_operations["Tracking and reliability"]
  node_idempotency["Idempotency service"]
  node_audit["Audit logging"]
  node_metrics["Dashboard metrics"]
end

node_admin(("Platform admin"))
node_clientapp(("Client application"))
node_email{{"SMTP / Brevo"}}

node_admin -->|"uses"| node_dashboardui
node_dashboardui -.->|"requests data"| node_frontendapi
node_clientapp -->|"submits request"| node_notificationapi
node_notificationapi -.->|"handles submission"| node_notificationservice
node_batchapi -.->|"submits batch"| node_notificationservice
node_notificationservice -->|"checks and stores"| node_idempotency
node_notificationservice -->|"persists notification"| node_notificationstore
node_scheduler -->|"loads due work"| node_notificationstore
node_scheduler -->|"dispatches processing"| node_engine
node_engine -->|"resolves template"| node_templateadmin
node_engine -->|"renders content"| node_renderer
node_engine -->|"selects provider"| node_providers
node_providers -->|"sends email"| node_email
node_engine -->|"updates status"| node_notificationstore
node_authapi -.->|"handles login"| node_authservice
node_authservice -->|"reads and saves"| node_userstore
node_appadmin -->|"persists applications"| node_appstore
node_appadmin -->|"publishes changes"| node_audit
node_templateadmin -->|"stores versions"| node_templatestore
node_templateadmin -->|"publishes changes"| node_audit
node_metricsui -->|"shows metrics"| node_metrics
node_metrics -->|"queries counts"| node_notificationstore
node_auditui -->|"shows audit history"| node_audit
node_playground -->|"tests API"| node_clientapp

click node_dashboardui "https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/App.tsx"
click node_playground "https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/playground/PlaygroundPage.tsx"
click node_frontendapi "https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/api/client.ts"
click node_authapi "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/auth/controller/AuthController.java"
click node_authservice "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/auth/service/AuthService.java"
click node_userstore "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/auth/entity/User.java"
click node_appadmin "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/application/service/ApplicationService.java"
click node_appstore "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/application/entity/Application.java"
click node_templateadmin "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/service/TemplateService.java"
click node_templatestore "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/entity/Template.java"
click node_notificationapi "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/controller/NotificationController.java"
click node_batchapi "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/controller/BatchNotificationController.java"
click node_notificationservice "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/service/NotificationService.java"
click node_notificationstore "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/entity/Notification.java"
click node_scheduler "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/scheduler/NotificationSchedulerService.java"
click node_engine "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java"
click node_renderer "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/service/PlaceholderTemplateRenderer.java"
click node_providers "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/provider/DefaultProviderSelector.java"
click node_idempotency "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/idempotency/IdempotencyService.java"
click node_audit "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/audit/DatabaseAuditPublisher.java"
click node_metrics "https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/dashboard/MetricsService.java"
click node_auditui "https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/pages/AuditLogsPage.tsx"
click node_metricsui "https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/pages/DashboardPage.tsx"

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_dashboardui,node_playground,node_frontendapi,node_auditui,node_metricsui,node_clientapp toneBlue
class node_authapi,node_authservice,node_userstore toneAmber
class node_appadmin,node_appstore,node_templateadmin,node_templatestore toneMint
class node_notificationapi,node_batchapi,node_notificationservice,node_notificationstore,node_scheduler,node_engine,node_renderer,node_providers toneRose
class node_idempotency,node_audit,node_metrics,node_admin,node_email toneIndigo
```

## Components

### Admin dashboard

- [Dashboard UI](https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [API playground](https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/playground/PlaygroundPage.tsx): `frontend/src/playground/PlaygroundPage.tsx`
- [Dashboard API client](https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/api/client.ts): `frontend/src/api/client.ts`
- [Audit log view](https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/pages/AuditLogsPage.tsx): `frontend/src/pages/AuditLogsPage.tsx`
- [Metrics dashboard](https://github.com/dhruvjain01/notifyhub/blob/main/frontend/src/pages/DashboardPage.tsx): `frontend/src/pages/DashboardPage.tsx`

### Identity and tenants

- [Authentication API](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/auth/controller/AuthController.java): `backend/src/main/java/com/notifyhub/auth/controller/AuthController.java`
- [Authentication service](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/auth/service/AuthService.java): `backend/src/main/java/com/notifyhub/auth/service/AuthService.java`
- [Users and tokens](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/auth/entity/User.java): `backend/src/main/java/com/notifyhub/auth/entity/User.java`

### Platform management

- [Application management](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/application/service/ApplicationService.java): `backend/src/main/java/com/notifyhub/application/service/ApplicationService.java`
- [Application records](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/application/entity/Application.java): `backend/src/main/java/com/notifyhub/application/entity/Application.java`
- [Template management](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/service/TemplateService.java): `backend/src/main/java/com/notifyhub/template/service/TemplateService.java`
- [Template versions](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/entity/Template.java): `backend/src/main/java/com/notifyhub/template/entity/Template.java`

### Notification delivery

- [Notification API](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/controller/NotificationController.java): `backend/src/main/java/com/notifyhub/notification/controller/NotificationController.java`
- [Batch API](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/controller/BatchNotificationController.java): `backend/src/main/java/com/notifyhub/notification/controller/BatchNotificationController.java`
- [Submission service](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/service/NotificationService.java): `backend/src/main/java/com/notifyhub/notification/service/NotificationService.java`
- [Notification records](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/entity/Notification.java): `backend/src/main/java/com/notifyhub/notification/entity/Notification.java`
- [Background scheduler](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/scheduler/NotificationSchedulerService.java): `backend/src/main/java/com/notifyhub/scheduler/NotificationSchedulerService.java`
- [Delivery engine](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java): `backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java`
- [Template renderer](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/template/service/PlaceholderTemplateRenderer.java): `backend/src/main/java/com/notifyhub/template/service/PlaceholderTemplateRenderer.java`
- [Email providers](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/provider/DefaultProviderSelector.java): `backend/src/main/java/com/notifyhub/provider/DefaultProviderSelector.java`

### Tracking and reliability

- [Idempotency service](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/notification/idempotency/IdempotencyService.java): `backend/src/main/java/com/notifyhub/notification/idempotency/IdempotencyService.java`
- [Audit logging](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/audit/DatabaseAuditPublisher.java): `backend/src/main/java/com/notifyhub/audit/DatabaseAuditPublisher.java`
- [Dashboard metrics](https://github.com/dhruvjain01/notifyhub/blob/main/backend/src/main/java/com/notifyhub/dashboard/MetricsService.java): `backend/src/main/java/com/notifyhub/dashboard/MetricsService.java`

### Other components

- **Platform admin**
- **Client application**
- **SMTP / Brevo**

## Connections

- Platform admin → Dashboard UI: uses (evidence: `README.md`)
- Dashboard UI → Dashboard API client: requests data
- Client application → Notification API: submits request (evidence: `README.md`)
- Notification API → Submission service: handles submission (evidence: `backend/src/main/java/com/notifyhub/notification/controller/NotificationController.java`)
- Batch API → Submission service: submits batch
- Submission service → Idempotency service: checks and stores (evidence: `backend/src/main/java/com/notifyhub/notification/service/NotificationService.java`)
- Submission service → Notification records: persists notification (evidence: `backend/src/main/java/com/notifyhub/notification/service/NotificationService.java`)
- Background scheduler → Notification records: loads due work (evidence: `backend/src/main/java/com/notifyhub/scheduler/NotificationSchedulerService.java`)
- Background scheduler → Delivery engine: dispatches processing (evidence: `backend/src/main/java/com/notifyhub/scheduler/NotificationSchedulerService.java`)
- Delivery engine → Template management: resolves template (evidence: `backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java`)
- Delivery engine → Template renderer: renders content (evidence: `backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java`)
- Delivery engine → Email providers: selects provider (evidence: `backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java`)
- Email providers → SMTP / Brevo: sends email (evidence: `README.md`)
- Delivery engine → Notification records: updates status (evidence: `backend/src/main/java/com/notifyhub/notification/engine/NotificationEngine.java`)
- Authentication API → Authentication service: handles login
- Authentication service → Users and tokens: reads and saves (evidence: `backend/src/main/java/com/notifyhub/auth/service/AuthService.java`)
- Application management → Application records: persists applications (evidence: `backend/src/main/java/com/notifyhub/application/service/ApplicationService.java`)
- Application management → Audit logging: publishes changes (evidence: `backend/src/main/java/com/notifyhub/application/service/ApplicationService.java`)
- Template management → Template versions: stores versions (evidence: `backend/src/main/java/com/notifyhub/template/service/TemplateService.java`)
- Template management → Audit logging: publishes changes (evidence: `backend/src/main/java/com/notifyhub/template/service/TemplateService.java`)
- Metrics dashboard → Dashboard metrics: shows metrics (evidence: `README.md`)
- Dashboard metrics → Notification records: queries counts (evidence: `backend/src/main/java/com/notifyhub/dashboard/MetricsService.java`)
- Audit log view → Audit logging: shows audit history (evidence: `README.md`)
- API playground → Client application: tests API (evidence: `README.md`)
