# amoghk04/notified architecture

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

- Interactive diagram: https://gitdiagram.com/amoghk04/notified
- Repository: https://github.com/amoghk04/notified

## Overview

##### Project type and purpose
- This is a microservices-based “Personalized Notification System” called **Notified**.
- Its goal is to accept notification requests (e.g. email, SMS, push), apply user-specific preferences and business rules, and deliver messages via multiple channels.

##### (minimal) file structure
- Top level shows only .gitignore, LICENSE, README.md, but the README calls out “microservices,” implying multiple service components in separate repositories or folders.
- Expect subdirectories or separate repos for services like “api-gateway,” “user-service,” “notification-service,” etc.

##### README for additional insights
- Confirms a “Personalized Notification System” implemented as microservices.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Ingress Layer"
        Client["Client Application"]:::external
        APIGW["API Gateway"]:::micro
        Auth["Auth Service"]:::micro
    end

    subgraph "Core Services"
        Orch["Notification Orchestrator"]:::micro
        UserSvc["User Profile Service"]:::micro
    end

    subgraph "Delivery Services"
        Email["Email Service"]:::micro
        SMS["SMS Service"]:::micro
        Push["Push Notification Service"]:::micro
    end

    subgraph "Message Broker"
        Broker["Message Broker"]:::broker
    end

    subgraph "Datastores"
        UserDB["User DB (Postgres/NoSQL)"]:::db
        AuditDB["Audit Log Store"]:::db
    end

    subgraph "External Systems"
        SMTP["SMTP Provider"]:::external
        SMSGW["SMS Gateway"]:::external
        PushGW["Push API"]:::external
    end

    subgraph "Monitoring & Logging"
        Monitoring["Monitoring & Logging Stack"]:::external
    end

    Client -->|requests| APIGW
    APIGW -->|auth request| Auth
    Auth -->|auth confirmation| APIGW
    APIGW -->|forwards request| Orch
    Orch -->|get preferences| UserSvc
    UserSvc -->|returns prefs| Orch
    Orch -->|publish event| Broker
    Broker -->|deliver email event| Email
    Broker -->|deliver sms event| SMS
    Broker -->|deliver push event| Push
    Email -->|send email| SMTP
    SMS -->|send sms| SMSGW
    Push -->|send push| PushGW
    Email -->|send result| Orch
    SMS -->|send result| Orch
    Push -->|send result| Orch
    Orch -->|log audit| AuditDB
    UserSvc -->|store user data| UserDB
    APIGW -->|metrics| Monitoring
    Auth -->|metrics| Monitoring
    Orch -->|metrics| Monitoring
    Email -->|metrics| Monitoring
    SMS -->|metrics| Monitoring
    Push -->|metrics| Monitoring

    Doc["Project Documentation"]:::external

    class Client,SMTP,SMSGW,PushGW,Monitoring,Doc external
    class APIGW,Auth,Orch,UserSvc,Email,SMS,Push micro
    class Broker broker
    class UserDB,AuditDB db

    click Doc "https://github.com/amoghk04/notified/blob/main/README.md"
```
