# ebrahimgad123/pharm-backend architecture

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

- Interactive diagram: https://gitdiagram.com/ebrahimgad123/pharm-backend
- Repository: https://github.com/ebrahimgad123/pharm-backend

## Overview

##### Project Type and Purpose
- This is a backend-only REST API service (Node.js + Express + TypeScript) that manages an online pharmacy system: patients, pharmacists, administrators, orders, carts, chat messaging, prescriptions, and payments.

##### File Structure Analysis
- Top‐level “server” folder with typical MVC layers under `src/`:
- `routes/` → defines HTTP endpoints
- `controllers/` → request handlers & orchestration
- `services/` → third‐party integrations (e.g., email)
- `models/` → data schema/entities (MongoDB or SQL ORM)
- `middleware/` → authentication, RBAC, error handling
- `config/` → DB connection, environment config
- `utils/`, `validation/` → helper classes, JWT token generation, input schemas
- Postman collections under `server/*_postman` show the client personas (patient, pharmacist, admin, chat).

##### README Insights
- The README is minimal, but the file structure and Postman examples indicate a layered REST API that:
- Secures endpoints via JWT
- Implements role‐based access control
- Offers CRUD operations for users, products, orders
- Supports real‐time‐style chat via HTTP endpoints

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients Layer
    subgraph "Clients" 
        direction TB
        PatientUI["Patient UI"]:::client
        PharmacistUI["Pharmacist UI"]:::client
        AdminUI["Admin UI"]:::client
        ChatUI["Chat UI"]:::client
    end

    %% API Server Entry
    APIEntry["API Server Entry\n(index.ts)"]:::entry
    click APIEntry "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/index.ts"

    %% Routing Layer
    subgraph "Routing Layer" 
        direction TB
        RoutingLayer["Routes\n(server/src/routes/)"]:::routing
    end
    click RoutingLayer "https://github.com/ebrahimgad123/pharm-backend/tree/main/server/src/routes/"

    %% Middleware Layer
    subgraph "Middleware Layer"
        direction TB
        AuthJWT["JWT Verification\n(verifyTokens.ts)"]:::middleware
        RBAC["Role-Based Access\n(userRole.ts)"]:::middleware
        ErrorHandle["Error Handling\n(errorHandling.ts)"]:::middleware
    end
    click AuthJWT "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/middleware/verifyTokens.ts"
    click RBAC "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/middleware/userRole.ts"
    click ErrorHandle "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/middleware/errorHandling.ts"

    %% Controllers Layer
    subgraph "Controllers Layer"
        direction TB
        AuthCtrl["AuthController\n(authController.ts)"]:::controller
        PatientCtrl["PatientController\n(patientController.ts)"]:::controller
        PharmacistCtrl["PharmacistController\n(pharmacistController.ts)"]:::controller
        AdminCtrl["AdministratorController\n(adminstratorController.ts)"]:::controller
        MedicineCtrl["MedicineController\n(medicineController.ts)"]:::controller
        CartCtrl["CartController\n(cartController.ts)"]:::controller
        OrderCtrl["OrderController\n(orderController.ts)"]:::controller
        PaymentCtrl["PaymentController\n(PaymentController.ts)"]:::controller
        ChatCtrl["ChatController\n(chatController.ts)"]:::controller
        MessageCtrl["MessageController\n(messageControllers.ts)"]:::controller
    end
    click AuthCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/authController.ts"
    click PatientCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/patientController.ts"
    click PharmacistCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/pharmacistController.ts"
    click AdminCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/adminstratorController.ts"
    click MedicineCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/medicineController.ts"
    click CartCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/cartController.ts"
    click OrderCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/orderController.ts"
    click PaymentCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/PaymentController.ts"
    click ChatCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/chatController.ts"
    click MessageCtrl "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/controllers/messageControllers.ts"

    %% Services Layer
    subgraph "Services Layer"
        direction TB
        EmailService["Email Notifications\n(sendEmail.ts)"]:::service
    end
    click EmailService "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/services/sendEmail.ts"

    %% Models Layer
    subgraph "Models Layer"
        direction TB
        UserModel["User Model\n(User.ts)"]:::model
        PatientModel["Patient Model\n(Patient.ts)"]:::model
        PharmacistModel["Pharmacist Model\n(pharmacist.ts)"]:::model
        AdminModel["Administrator Model\n(Adminstrator.ts)"]:::model
        MedicineModel["Medicine Model\n(medicine.ts)"]:::model
        CartModel["Cart Model\n(Cart.ts)"]:::model
        OrderModel["Order Model\n(Order.ts)"]:::model
        PackageModel["Package Model\n(Package.ts)"]:::model
        PrescriptionModel["Prescription Model\n(Prescription.ts)"]:::model
        ChatModel["Chat Model\n(Chat.ts)"]:::model
        MessageModel["Message Model\n(Message.ts)"]:::model
    end
    click UserModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/User.ts"
    click PatientModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Patient.ts"
    click PharmacistModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/pharmacist.ts"
    click AdminModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Adminstrator.ts"
    click MedicineModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/medicine.ts"
    click CartModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Cart.ts"
    click OrderModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Order.ts"
    click PackageModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Package.ts"
    click PrescriptionModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Prescription.ts"
    click ChatModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Chat.ts"
    click MessageModel "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/models/Message.ts"

    %% Config & Utils Layer
    subgraph "Config & Utils Layer"
        direction TB
        DBConfig["DB Connection\n(db.ts)"]:::config
        TokenGen["Token Generation\n(generateToken.ts)"]:::util
        Exceptions["Custom Exceptions\n(ExceptionClass.ts)"]:::util
        Permissions["Permission Helpers\n(premissition.ts)"]:::util
        Validation["Patient Validation\n(patientSchema.ts)"]:::validation
    end
    click DBConfig "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/config/db.ts"
    click TokenGen "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/utils/generateToken.ts"
    click Exceptions "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/utils/ExceptionClass.ts"
    click Permissions "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/utils/premissition.ts"
    click Validation "https://github.com/ebrahimgad123/pharm-backend/blob/main/server/src/validation/patientSchema.ts"

    %% Database and External Services
    Database["Database\n(MongoDB/PostgreSQL)"]:::database
    EmailExt["External Email Service"]:::external
    PostmanPatient["Patient Postman\n(server/server/patient_postman/)"]:::postman
    PostmanPharma["Pharmacist Postman\n(server/server/Pharmacist_postman/)"]:::postman
    PostmanAdmin["Administrator Postman\n(server/server/admin_postman/)"]:::postman
    PostmanChat["Chat Postman\n(server/server/Chat_postman/)"]:::postman
    click PostmanPatient "https://github.com/ebrahimgad123/pharm-backend/tree/main/server/server/patient_postman/"
    click PostmanPharma "https://github.com/ebrahimgad123/pharm-backend/tree/main/server/server/Pharmacist_postman/"
    click PostmanAdmin "https://github.com/ebrahimgad123/pharm-backend/tree/main/server/server/admin_postman/"
    click PostmanChat "https://github.com/ebrahimgad123/pharm-backend/tree/main/server/server/Chat_postman/"

    %% Data Flow
    PatientUI --> APIEntry
    PharmacistUI --> APIEntry
    AdminUI --> APIEntry
    ChatUI --> APIEntry

    APIEntry --> RoutingLayer
    RoutingLayer --> AuthJWT
    AuthJWT --> RBAC
    RBAC --> ErrorHandle
    ErrorHandle --> AuthCtrl
    ErrorHandle --> PatientCtrl
    ErrorHandle --> PharmacistCtrl
    ErrorHandle --> AdminCtrl
    ErrorHandle --> MedicineCtrl
    ErrorHandle --> CartCtrl
    ErrorHandle --> OrderCtrl
    ErrorHandle --> PaymentCtrl
    ErrorHandle --> ChatCtrl
    ErrorHandle --> MessageCtrl

    AuthCtrl --> EmailService
    PatientCtrl --> UserModel
    PatientCtrl --> PatientModel
    PharmacistCtrl --> PharmacistModel
    AdminCtrl --> AdminModel
    MedicineCtrl --> MedicineModel
    CartCtrl --> CartModel
    OrderCtrl --> OrderModel
    OrderCtrl --> PackageModel
    PaymentCtrl --> PackageModel
    PaymentCtrl --> PrescriptionModel
    ChatCtrl --> ChatModel
    MessageCtrl --> MessageModel

    EmailService --> EmailExt
    UserModel --> Database
    PatientModel --> Database
    PharmacistModel --> Database
    AdminModel --> Database
    MedicineModel --> Database
    CartModel --> Database
    OrderModel --> Database
    PackageModel --> Database
    PrescriptionModel --> Database
    ChatModel --> Database
    MessageModel --> Database

    APIEntry --> DBConfig
    AuthCtrl --> TokenGen
    AuthCtrl --> Permissions
    AuthCtrl --> Exceptions
    PatientCtrl --> Validation

    %% Classes
    classDef client fill:#DDEEFF,stroke:#888,stroke-width:1px
    classDef entry fill:#BBCCFF,stroke:#444,stroke-width:1px
    classDef routing fill:#CCE5FF,stroke:#339,stroke-width:1px
    classDef middleware fill:#EEEEEE,stroke:#666,stroke-width:1px
    classDef controller fill:#CCFFCC,stroke:#393,stroke-width:1px
    classDef service fill:#CCFFCC,stroke:#393,stroke-width:1px
    classDef model fill:#FFDDAA,stroke:#996633,stroke-width:1px
    classDef config fill:#FFEECC,stroke:#AA8844,stroke-width:1px
    classDef util fill:#EEEEEE,stroke:#888,stroke-width:1px
    classDef validation fill:#FFDDFF,stroke:#DD88DD,stroke-width:1px
    classDef database fill:#FFDDCC,stroke:#AA5533,stroke-width:1px
    classDef external fill:#CCCCFF,stroke:#5555AA,stroke-width:1px
    classDef postman fill:#F0F0F0,stroke:#999,stroke-width:1px
```
