# yassirscreed/pharmacist architecture

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

- Interactive diagram: https://gitdiagram.com/yassirscreed/pharmacist
- Repository: https://github.com/yassirscreed/pharmacist

## Overview

##### Main Components

A. Client-Side (Mobile App)
- UI Layer (Jetpack Compose)
- View Models Layer
- Repository Layer
- Local Database (Room)
- Utils & Helpers

B. Backend Services (Firebase)
- Authentication Service
- Firestore Database
- Firebase Storage
- Real-time Sync Service

**┌─ Mobile Application ──────────────────────────────────────┐**

- ┌─ UI Layer (Screens) ─────────────────────────┐       │
- Main Screen        - Login/Register         │       │
- Pharmacy Panel     - Medicine Panel         │       │
- Search Screens     - Location Screens       │       │
- ┘       │
- ▲                               │

- ┌─ ViewModels ─────────┴────────────────────────┐     │
- PharmaciesViewModel    - UserViewModel       │     │
- LoginViewModel         - RegisterViewModel   │     │
- NetworkStateViewModel  - PhotoCacheViewModel │     │
- ┘      │
- ▲                               │

- ┌─ Repository Layer ────┴────────────────────────┐    │
- MedicineRepository                           │    │
- PharmacyRepository                           │    │
- ┘      │
- ▲                    ▲               │

- ┌─ Local Cache ───┴─┐        ┌────────┴──────────┐   │
- Room Database    │◄─────►│  Network Services  │   │
- Medicine Cache  │        │  - API Clients    │   │
- Pharmacy Cache  │        │  - Data Sync      │   │
- ┘        └─────────────────────┘  │
- ┘
- ▲

**┌─ Firebase Backend ──────┴───────────────────────────┐**

- ┌─ Authentication ─┐  ┌─ Firestore DB ─┐          │
- User Management  │  │ - Users        │          │
- ┘   │ - Pharmacies   │          │
- Medicines     │          │
- ┌─ Storage ───────┐  └───────────────┘           │
- Photos/Images   │                              │
- ┘                               │
- ┘

##### Important Relationships to Highlight

a. Data Flow:
- Bi-directional flow between UI and ViewModels
- One-way flow from repositories to ViewModels
- Sync between local cache and backend

b. Dependencies:
- Direct dependencies between components
- Cross-cutting concerns (NetworkStateListener)

##### Additional Elements

- Notes about offline capabilities
- Critical security paths
- Where resource optimization occurs

##### Implementation Details

- Use standardized UML notation where applicable
- Component versions/technologies
- Notes about scalability points
- Authentication flow paths

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef viewmodel fill:#2ecc71,stroke:#27ae60,color:white
    classDef repository fill:#f1c40f,stroke:#f39c12,color:black
    classDef local fill:#e67e22,stroke:#d35400,color:white
    classDef network fill:#9b59b6,stroke:#8e44ad,color:white
    classDef backend fill:#e74c3c,stroke:#c0392b,color:white
    classDef utils fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Main Application Container
    subgraph MobileApp["Mobile Application"]
        %% UI Layer
        subgraph UILayer["UI Layer"]
            LoginScreen["Login Screen"]:::ui
            RegisterScreen["Register Screen"]:::ui
            PharmacyPanel["Pharmacy Panel"]:::ui
            MedicinePanel["Medicine Panel"]:::ui
            SearchScreens["Search Screens"]:::ui
            LocationScreens["Location Screens"]:::ui
        end

        %% ViewModels Layer
        subgraph ViewModels["ViewModels Layer"]
            PharmaciesVM["PharmaciesViewModel"]:::viewmodel
            LoginVM["LoginViewModel"]:::viewmodel
            UserVM["UserViewModel"]:::viewmodel
            NetworkStateVM["NetworkStateViewModel"]:::viewmodel
            PhotoCacheVM["PhotoCacheViewModel"]:::viewmodel
        end

        %% Repository Layer
        subgraph Repositories["Repository Layer"]
            MedicineRepo["MedicineRepository"]:::repository
            PharmacyRepo["PharmacyRepository"]:::repository
        end

        %% Local Storage
        subgraph LocalStorage["Local Storage"]
            RoomDB["Room Database"]:::local
            MedicineDB["Medicine Database"]:::local
            PharmacyDB["Pharmacy Database"]:::local
            MedicineDAO["Medicine DAO"]:::local
            PharmacyDAO["Pharmacy DAO"]:::local
        end

        %% Utils
        subgraph Utils["Utils & Helpers"]
            BarcodeScanner["Barcode Scanner"]:::utils
            UtilsHelper["Utils"]:::utils
        end
    end

    %% Backend Services
    subgraph Backend["Firebase Backend"]
        Auth["Authentication"]:::backend
        Firestore["Firestore DB"]:::backend
        Storage["Firebase Storage"]:::backend
    end

    %% Relationships
    UILayer --> ViewModels
    ViewModels --> Repositories
    Repositories --> LocalStorage
    Repositories --> Backend
    LocalStorage <--> Backend
    Utils --> UILayer
    Utils --> ViewModels

    %% Click Events
    click LoginScreen "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/screens/LoginScreen.kt"
    click RegisterScreen "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/screens/RegisterScreen.kt"
    click PharmacyPanel "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/screens/PharmacyPanelScreen.kt"
    click MedicinePanel "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/screens/MedicinePanelScreen.kt"
    click PharmaciesVM "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/views/PharmaciesViewModel.kt"
    click LoginVM "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/views/LoginViewModel.kt"
    click UserVM "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/views/UserViewModel.kt"
    click NetworkStateVM "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/views/NetworkStateViewModel.kt"
    click PhotoCacheVM "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/ui/views/PhotoCacheViewModel.kt"
    click MedicineRepo "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/database/MedicineRepository.kt"
    click PharmacyRepo "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/database/PharmacyRepository.kt"
    click MedicineDB "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/database/MedicineDatabase.kt"
    click PharmacyDB "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/database/PharmacyDatabase.kt"
    click MedicineDAO "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/database/MedicineDao.kt"
    click PharmacyDAO "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/database/PharmacyDao.kt"
    click BarcodeScanner "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/utils/BarcodeScanner.kt"
    click UtilsHelper "https://github.com/yassirscreed/PharmacIST/blob/main/app/src/main/java/com/ist/pharmacist/utils/Utils.kt"
```
