# nikoladrljaca/scannerate architecture

> Architecture diagram of the GitHub repository nikoladrljaca/scannerate, 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/nikoladrljaca/scannerate
- Repository: https://github.com/nikoladrljaca/scannerate

## Overview

##### Main Components Identification

a. User Interface Layer
- Around the main UI components found in ui/ directory:
- Home Screen (HomeScanFragment)
- Detail Scan Screen
- Support Screen
- Info/About Screen
- OnBoarding Screens

b. Core Services Layer
- Text Recognition Service (using ML Kit)
- Entity Extraction Service
- PDF Export Service
- Text Filter Service
- Billing Service

c. Data Layer
- Local Database (Room)
- DataStore (Preferences)
- Repositories

##### Architecture Pattern
The project follows a clean architecture pattern with MVVM, as evidenced by:
- ViewModels for each major screen
- Repository pattern for data access
- Use cases for business logic
- Dependency injection (using Koin/Dagger, based on di/ directory)

**[User Interface Layer]**
- ↑↓
**[ViewModel Layer]**
- ↑↓
**[Use Cases/Services Layer]**
- ↑↓
**[Repository Layer]**
- ↑↓
**[Data Sources Layer]**

##### Key Relationships to Highlight

a. Data Flow
- Camera/Gallery → Text Recognition → Storage
- Text → Entity Extraction → Filtered Results
- Scans → PDF Export

b. Dependencies
- UI → ViewModel → Repository
- Services → External APIs (ML Kit)

##### Component Details

For each major component, show:
- Input/Output
- Dependencies
- Key responsibilities

- Component Name |

- Responsibilities|
- Item 1       |
- Item 2       |

##### Implementation Notes

- Dependency injection paths
- Asynchronous operations (using Kotlin Flows/Coroutines)
- Database operations
- File system interactions

##### Additional Elements

Annotations for:
- Third-party libraries
- Platform components
- Configuration elements
- Build process elements

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#2ecc71,stroke:#27ae60,color:white
    classDef data fill:#e67e22,stroke:#d35400,color:white
    classDef external fill:#9b59b6,stroke:#8e44ad,color:white
    classDef util fill:#95a5a6,stroke:#7f8c8d,color:white

    %% UI Layer
    subgraph UI
        Home["Home Screen"]:::ui
        Detail["Detail Scan Screen"]:::ui
        Support["Support Screen"]:::ui
        Info["Info Screen"]:::ui
        OnBoarding["OnBoarding Screens"]:::ui
    end

    %% ViewModel Layer
    subgraph ViewModels
        HomeVM["Home ViewModel"]:::util
        DetailVM["Detail ViewModel"]:::util
        SupportVM["Support ViewModel"]:::util
    end

    %% Services Layer
    subgraph Services
        TextRecog["Text Recognition Service"]:::service
        EntityExtract["Entity Extraction Service"]:::service
        PDFExport["PDF Export Service"]:::service
        TextFilter["Text Filter Service"]:::service
        Billing["Billing Service"]:::service
    end

    %% Data Layer
    subgraph Data
        LocalDB[(Local Database)]:::data
        DataStore[(DataStore)]:::data
        ScanRepo["Scan Repository"]:::data
        FilterRepo["Filtered Text Repository"]:::data
    end

    %% External Services
    MLKit["ML Kit"]:::external

    %% Dependencies and Relationships
    Home --> HomeVM
    Detail --> DetailVM
    Support --> SupportVM

    HomeVM --> TextRecog
    HomeVM --> ScanRepo
    DetailVM --> EntityExtract
    DetailVM --> PDFExport
    DetailVM --> TextFilter
    DetailVM --> FilterRepo
    SupportVM --> Billing

    TextRecog --> MLKit
    EntityExtract --> MLKit

    ScanRepo --> LocalDB
    FilterRepo --> LocalDB
    ScanRepo --> DataStore

    %% Click Events
    click Home "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/ui/home/HomeScanFragment.kt"
    click Detail "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/ui/detailscan/DetailScanFragment.kt"
    click Support "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/ui/support/SupportFragment.kt"
    click Info "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/ui/info/AboutFragment.kt"
    click OnBoarding "https://github.com/nikolaDrljaca/scannerate/tree/main/app/src/main/java/com/drbrosdev/studytextscan/ui/onBoarding/screens/"
    click TextRecog "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/service/textextract/ScanTextFromImageUseCase.kt"
    click EntityExtract "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/service/entityextraction/EntityExtractionUseCase.kt"
    click PDFExport "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/service/pdfExport/PdfExportService.kt"
    click TextFilter "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/service/textFilter/TextFilterService.kt"
    click Billing "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/service/billing/BillingClientService.kt"
    click LocalDB "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/persistence/database/ApplicationDatabase.kt"
    click DataStore "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/datastore/AppPreferences.kt"
    click ScanRepo "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/persistence/repository/ScanRepository.kt"
    click FilterRepo "https://github.com/nikolaDrljaca/scannerate/blob/main/app/src/main/java/com/drbrosdev/studytextscan/persistence/repository/FilteredTextRepository.kt"

    %% Legend
    subgraph Legend
        UI_L["UI Components"]:::ui
        Service_L["Services"]:::service
        Data_L["Data Components"]:::data
        External_L["External Services"]:::external
        Util_L["Utility Components"]:::util
    end
```
