# alecmucz/hospitaldeliveryinterface architecture

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

- Interactive diagram: https://gitdiagram.com/alecmucz/hospitaldeliveryinterface
- Repository: https://github.com/alecmucz/hospitaldeliveryinterface

## Overview

##### Main Components

a) Client-Side Components:
- JavaFX UI Layer (represented by FXML files)
- Controllers Layer
- Model Layer
- Theme Management (Light/Dark mode)

b) External Services:
- Firebase Authentication
- Firestore Database
- Algolia Search Service
- LibreTranslate API

**[Presentation Layer]**

- UI Components (FXML)
- LoginForm
- Homepage
- DeliveryForm
- OrderCard
- Other UI components

**[Application Layer]**

- Controllers
- LoginFormController
- HomepageController
- DeliveryFormController
- Other controllers

**[Domain Layer]**

- Models
- DeliveryRequisition
- Employee
- OrderHistory
- Other domain models

**[Integration Layer]**

- Firebase Integration
- FirestoreContext
- DataBaseMgmt
- FirebaseListener

- Algolia Integration
- AlgoliaContext
- AlgoliaMgmt

- Translation Service
- MitchTextTranslate

##### Key Elements to Highlight

- Blue: UI Components
- Green: Controllers
- Yellow: Models
- Red: External Services
- Purple: Integration Components

b) Connection Types:
- Double lines: Real-time data flow

##### Important Relationships

- Real-time updates between Firebase and the application
- Authentication flow from UI to Firebase
- Search requests flow to Algolia
- Translation requests to LibreTranslate
- Data flow between controllers and models
- Event handling between UI and controllers

##### Technical Details

- JavaFX as the UI framework
- Firebase Authentication and Firestore for backend
- SHA-256 for password hashing
- Algolia Search API integration
- LibreTranslate API integration

##### Notes

- Keep the main flow clear and centered
- Related components together
- Use appropriate scaling for different components based on their importance
- Notes for critical processes like real-time updates and authentication

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef controller fill:#2ecc71,stroke:#27ae60,color:white
    classDef model fill:#f1c40f,stroke:#f39c12,color:black
    classDef external fill:#e74c3c,stroke:#c0392b,color:white
    classDef integration fill:#9b59b6,stroke:#8e44ad,color:white
    classDef theme fill:#1abc9c,stroke:#16a085,color:white

    %% Main Application
    MainApp["PharmaTracApp"]:::controller
    click MainApp "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/PharmaTracApp.java"

    %% Layers
    subgraph Presentation
        UI["UI Components"]
        LoginForm["LoginForm"]:::ui
        Homepage["Homepage"]:::ui
        DeliveryForm["DeliveryForm"]:::ui
        OrderCard["OrderCard"]:::ui
        
        click LoginForm "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/resources/com/example/hospitaldeliveryinterface/LoginForm.fxml"
        click Homepage "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/resources/com/example/hospitaldeliveryinterface/Homepage.fxml"
        click DeliveryForm "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/resources/com/example/hospitaldeliveryinterface/DeliveryForm.fxml"
        click OrderCard "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/resources/com/example/hospitaldeliveryinterface/OrderCard.fxml"
    end

    subgraph Controllers
        LoginCtrl["LoginFormController"]:::controller
        HomeCtrl["HomepageController"]:::controller
        DeliveryCtrl["DeliveryFormController"]:::controller
        OrderCtrl["OrderCardUIController"]:::controller
        ThemeCtrl["LightDarkMode"]:::theme
        
        click LoginCtrl "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/controllers/LoginFormController.java"
        click HomeCtrl "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/controllers/HomepageController.java"
        click DeliveryCtrl "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/controllers/DeliveryFormController.java"
        click OrderCtrl "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/controllers/OrderCardUIController.java"
        click ThemeCtrl "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/controllers/LightDarkMode.java"
    end

    subgraph Domain
        DeliveryReq["DeliveryRequisition"]:::model
        Employee["Employee"]:::model
        OrderHistory["OrderHistory"]:::model
        
        click DeliveryReq "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/model/DeliveryRequisition.java"
        click Employee "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/model/Employee.java"
        click OrderHistory "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/model/OrderHistory.java"
    end

    subgraph Integration
        FirestoreCtx["FirestoreContext"]:::integration
        DBMgmt["DataBaseMgmt"]:::integration
        FBListener["FirebaseListener"]:::integration
        AlgoliaCtx["AlgoliaContext"]:::integration
        AlgoliaMgmt["AlgoliaMgmt"]:::integration
        Translate["MitchTextTranslate"]:::integration
        
        click FirestoreCtx "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/firebase/FirestoreContext.java"
        click DBMgmt "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/firebase/DataBaseMgmt.java"
        click FBListener "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/firebase/FirebaseListener.java"
        click AlgoliaCtx "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/Algolia/AlgoliaContext.java"
        click AlgoliaMgmt "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/Algolia/AlgoliaMgmt.java"
        click Translate "https://github.com/alecmucz/hospitalDeliveryInterface/blob/master/src/main/java/com/example/hospitaldeliveryinterface/model/MitchTextTranslate.java"
    end

    subgraph External
        Firebase["Firebase Auth & Firestore"]:::external
        Algolia["Algolia Search"]:::external
        LibreTranslate["LibreTranslate API"]:::external
    end

    %% Relationships
    MainApp --> UI
    LoginForm --> LoginCtrl
    Homepage --> HomeCtrl
    DeliveryForm --> DeliveryCtrl
    OrderCard --> OrderCtrl
    
    LoginCtrl --> FirestoreCtx
    HomeCtrl --> FirestoreCtx
    DeliveryCtrl --> FirestoreCtx
    OrderCtrl --> FirestoreCtx
    
    FirestoreCtx --> DBMgmt
    DBMgmt --> Firebase
    FBListener --> Firebase
    
    AlgoliaCtx --> AlgoliaMgmt
    AlgoliaMgmt --> Algolia
    
    Translate --> LibreTranslate
    
    Controllers --> Domain
    Integration --> Domain

    %% Theme Management
    ThemeCtrl --> UI

    %% Legend
    subgraph Legend
        UI_L["UI Component"]:::ui
        Controller_L["Controller"]:::controller
        Model_L["Model"]:::model
        External_L["External Service"]:::external
        Integration_L["Integration Component"]:::integration
        Theme_L["Theme Component"]:::theme
    end
```
