# singfuse/singfact-ios architecture

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

- Interactive diagram: https://gitdiagram.com/singfuse/singfact-ios
- Repository: https://github.com/singfuse/singfact-ios

## Overview

##### Main Components

a. Client-Side Components:
- Main iOS App Module
- Widget Extension Module
- Firebase Integration Layer
- Data Models Layer
- UI Components Layer
- Views Layer

b. Server-Side Components:
- Firebase Backend Services
- Data Storage (Firestore, assumed from FactDocument.swift)

##### Business Logic Layer (Middle)
- Models (Fact, Favorite, Setting)
- Firebase Integration (FactDocument)

##### Data Layer (Bottom)
- Firebase Backend Services
- Cloud Storage

##### Detailed Component Breakdown

- Main App Components (SingFactApp, ContentView)
- Widget Components (SingFactWidget, SingFactWidgetBundle)
- Data Models (Fact, Favorite, Setting)
- Firebase Integration (FactDocument)
- UI Components (SwipeActionButton)

##### Technical Stack Indicators

Technology labels:
- SwiftUI
- Firebase
- WidgetKit
- iOS Framework

##### Additional Elements

Include:
- Testing components (SingFactTests, SingFactUITests)
- Asset management
- Configuration files
- Entitlements and permissions flow

Remember to:
- Keep components proportional to their importance
- Use consistent styling for similar components
- Version/date information
- Important architectural patterns (MVVM, if used)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and classes
    classDef presentation fill:#e1f5fe,stroke:#01579b
    classDef business fill:#e8f5e9,stroke:#1b5e20
    classDef data fill:#fff3e0,stroke:#e65100
    classDef testing fill:#f3e5f5,stroke:#4a148c
    classDef config fill:#fafafa,stroke:#424242

    %% Subgraphs for layers
    subgraph PresentationLayer
        MainApp["Main App (SingFactApp)"]
        ContentView["Content View"]
        FavoritesView["Favorites View"]
        
        subgraph WidgetExtension
            Widget["SingFact Widget"]
            WidgetBundle["Widget Bundle"]
        end
        
        UIComponents["UI Components"]
        SwipeButton["Swipe Action Button"]
    end

    subgraph BusinessLayer
        Models["Data Models"]
        Fact["Fact Model"]
        Favorite["Favorite Model"]
        Setting["Setting Model"]
        FirebaseIntegration["Firebase Integration"]
        FactDoc["Fact Document"]
    end

    subgraph DataLayer
        Firebase["Firebase Backend"]
        CloudStorage["Cloud Storage"]
    end

    subgraph TestingLayer
        UnitTests["SingFact Tests"]
        UITests["SingFact UI Tests"]
    end

    subgraph ConfigLayer
        CICD["CI/CD Pipeline"]
        AppEntitlements["App Entitlements"]
        WidgetEntitlements["Widget Entitlements"]
    end

    %% Relationships
    MainApp --> ContentView
    MainApp --> FavoritesView
    UIComponents --> SwipeButton
    ContentView --> Models
    FavoritesView --> Models
    Widget --> Models
    Models --> Fact
    Models --> Favorite
    Models --> Setting
    FirebaseIntegration --> FactDoc
    FactDoc <--> Firebase
    Firebase <--> CloudStorage
    UnitTests --> Models
    UITests --> MainApp

    %% Click events
    click MainApp "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/SingFactApp.swift"
    click Widget "https://github.com/singfuse/SingFact-iOS/blob/main/SingFactWidget/SingFactWidget.swift"
    click WidgetBundle "https://github.com/singfuse/SingFact-iOS/blob/main/SingFactWidget/SingFactWidgetBundle.swift"
    click FactDoc "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Firebase/FactDocument.swift"
    click Fact "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Models/Fact.swift"
    click Favorite "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Models/Favorite.swift"
    click Setting "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Models/Setting.swift"
    click SwipeButton "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Components/SwipeActionButton.swift"
    click ContentView "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Views/ContentView.swift"
    click FavoritesView "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/Views/FavoritesView.swift"
    click UnitTests "https://github.com/singfuse/SingFact-iOS/blob/main/SingFactTests/SingFactTests.swift"
    click UITests "https://github.com/singfuse/SingFact-iOS/blob/main/SingFactUITests/SingFactUITests.swift"
    click CICD "https://github.com/singfuse/SingFact-iOS/blob/main/ci_scripts/ci_post_clone.sh"
    click AppEntitlements "https://github.com/singfuse/SingFact-iOS/blob/main/SingFact/SingFact.entitlements"
    click WidgetEntitlements "https://github.com/singfuse/SingFact-iOS/blob/main/SingFactWidget/SingFactWidget.entitlements"

    %% Style applications
    class MainApp,ContentView,FavoritesView,Widget,WidgetBundle,UIComponents,SwipeButton presentation
    class Models,Fact,Favorite,Setting,FirebaseIntegration,FactDoc business
    class Firebase,CloudStorage data
    class UnitTests,UITests testing
    class CICD,AppEntitlements,WidgetEntitlements config
```
