# sonialr7iny/iquotes architecture

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

- Interactive diagram: https://gitdiagram.com/sonialr7iny/iquotes
- Repository: https://github.com/sonialr7iny/iquotes

## Overview

##### Project Type & Purpose
- Type: Cross-platform mobile/desktop/web app built with Flutter & Dart.
- Purpose: A standalone quotes manager with secure user authentication, local SQLite storage, Bloc/Cubit state management, dark mode, and no external backend.

##### High-Level Architectural Layers
a. Presentation Layer (UI)
– Flutter Widgets & Screens (in lib/modules & lib/layout)
– Theme & Styles (lib/shared/styles)
b. State Management Layer
– Cubits/Blocs (lib/shared/cubit & sign_in_with_cubit.dart, register_with_cubit.dart, etc.)
c. Data Layer
– Repository/Data Sources:
- SQLite local database (quotes_sqflite.dart + sqflite plugin)
- SharedPreferences (cache_helper.dart + shared_preferences plugin)
– Models (lib/models/quote_model.dart)
d. Service/Utility Layer
– BCrypt hashing service for passwords
– Input validation (regex in forms)
e. Plugins & Platform Integration
– Flutter plugins: sqflite, shared_preferences, bcrypt
– Platform channels handled by each plugin under android/, ios/, web/, windows/, linux/, macos/
f. Platform Hosts
– Android (Gradle/Kotlin entrypoint MainActivity.kt)
– iOS (AppDelegate.swift + Xcode project)
– Web (index.html + flutter_bootstrap.js)
– Desktop (Windows, Linux, macOS runner code)

##### Main Components & Their Relationships
- Presentation → interacts with → State Management
- State Management → dispatches calls to → Data Layer (Repositories)
- Data Layer → uses → Local DB (SQLite) and Local Cache (SharedPreferences)
- Service Layer (BCrypt, Validators) → called by → State Management (during auth flows)
- Plugins → mediate between Data Layer & Native Platform
- Platform Hosts → load → Flutter Engine → run → Dart code

##### Important Architectural Patterns & Principles
- Layered Architecture: presentation, business logic, data, platform
- Bloc/Cubit: unidirectional data flow—UI dispatches events, Cubit updates state, UI rebuilds.
- Repository Pattern: abstracts away raw DB calls behind quotes_sqflite.dart and cache_helper.dart
- Dependency Injection (implicit via static helpers or passing instances into Cubits)
- Cross-platform code reuse: one lib/ folder driving multiple native targets

##### Detailed Element List
- UI Modules: welcome_screen, splash_screen, quotes_screen, archived_screen, favorites_screen, etc.
- Cubits: AuthCubit (register/login), QuotesCubit (insert/update/delete/fetch), ThemeCubit (dark/light mode)
- Data Sources: CacheHelper (SharedPreferences), QuotesSqflite (SQLite)
- Models: QuoteModel
- Third-party plugins: flutter_bloc, sqflite, shared_preferences, bcrypt
- Native Hosts: Android’s MainActivity, iOS AppDelegate, Web index.html, Desktop runners

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        Welcome["Welcome Screen"]:::ui
        Splash["Splash Screen"]:::ui
        QuotesUI["Quotes Screen"]:::ui
        FavoritesUI["Favorites Screen"]:::ui
        ArchivedUI["Archived Screen"]:::ui
        HomeLayout["Home Layout"]:::ui
        HomeLayoutC["Home Layout w/ Cubit"]:::ui
    end

    %% State Management Layer
    subgraph "State Management Layer"
        direction TB
        SignInCubit["Sign-In Cubit"]:::logic
        RegisterCubit["Register Cubit"]:::logic
        SharedCubits["Shared Cubits\n(QuotesCubit, ThemeCubit)"]:::logic
        BlocObs["Bloc Observer"]:::logic
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        Sqflite["QuotesSqflite\n(SQLite)"]:::data
        Cache["CacheHelper\n(SharedPreferences)"]:::data
        QuoteModel["QuoteModel"]:::data
    end

    %% Service/Utility Layer
    subgraph "Service/Utility Layer"
        direction TB
        Styles["Styles & Themes"]:::util
        Colors["Color Constants"]:::util
        Components["UI Components & Constants"]:::util
    end

    %% Plugins & Platform Integration
    subgraph "Plugins & Platform Integration"
        direction TB
        Plugins["sqflite, shared_preferences, bcrypt"]:::plugin
    end

    %% Platform Hosts
    subgraph "Platform Hosts"
        direction TB
        Android["Android MainActivity"]:::platform
        iOS["iOS AppDelegate"]:::platform
        Web["Web index.html"]:::platform
        Windows["Windows Runner"]:::platform
        Linux["Linux Runner"]:::platform
        MacOS["macOS MainFlutterWindow"]:::platform
    end

    %% App Entrypoint
    Main["main.dart"]:::platform

    %% Connections
    Main -->|"initializes"| Welcome
    Main --> Splash
    Main --> QuotesUI
    Main --> FavoritesUI
    Main --> ArchivedUI
    Main --> HomeLayout
    Main --> HomeLayoutC

    %% Presentation to State Management
    Welcome -->|"dispatches events"| SignInCubit
    Splash -->|"renders based on"| SharedCubits
    QuotesUI -->|"uses"| SharedCubits
    FavoritesUI --> SharedCubits
    ArchivedUI --> SharedCubits
    HomeLayoutC --> SharedCubits

    %% State Management to Data Layer
    SignInCubit -->|"calls"| Cache
    SignInCubit -->|"calls"| Sqflite
    RegisterCubit --> Cache
    RegisterCubit --> Sqflite
    SharedCubits --> Sqflite
    SharedCubits --> Cache

    %% Data Layer to Model
    Sqflite --> QuoteModel
    Cache --> QuoteModel

    %% State Management to Service/Utility
    SignInCubit -->|"uses"| Styles
    SignInCubit --> Colors
    SharedCubits --> Components

    %% Data Layer to Plugins to Platform
    Sqflite --> Plugins
    Cache --> Plugins
    Plugins --> Android
    Plugins --> iOS
    Plugins --> Web
    Plugins --> Windows
    Plugins --> Linux
    Plugins --> MacOS

    %% Styles
    classDef ui fill:#bbdefb,stroke:#1e88e5,color:#000
    classDef logic fill:#c8e6c9,stroke:#43a047,color:#000
    classDef data fill:#ffe0b2,stroke:#fb8c00,color:#000
    classDef util fill:#e1bee7,stroke:#8e24aa,color:#000
    classDef plugin fill:#eeeeee,stroke:#757575,color:#000
    classDef platform fill:#cfd8dc,stroke:#546e7a,color:#000

    %% Click Events for component mapping
    click Welcome "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/init/welcome_screen.dart"
    click Splash "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/splash_screen/splash_screen.dart"
    click QuotesUI "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/quotes/quotes_screen.dart"
    click FavoritesUI "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/favorites/favorites_screen.dart"
    click ArchivedUI "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/archive/archived_screen.dart"
    click HomeLayout "https://github.com/sonialr7iny/iquotes/blob/master/lib/layout/home_layout.dart"
    click HomeLayoutC "https://github.com/sonialr7iny/iquotes/blob/master/lib/layout/home_layout_with_cubit.dart"
    click SignInCubit "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/login/sign_in_with_cubit.dart"
    click RegisterCubit "https://github.com/sonialr7iny/iquotes/blob/master/lib/modules/register/register_with_cubit.dart"
    click SharedCubits "https://github.com/sonialr7iny/iquotes/blob/master/lib/shared/cubit/cubit.dart"
    click BlocObs "https://github.com/sonialr7iny/iquotes/blob/master/lib/shared/styles/bloc_observer.dart"
    click Sqflite "https://github.com/sonialr7iny/iquotes/blob/master/lib/quotes_sqflite.dart"
    click Cache "https://github.com/sonialr7iny/iquotes/blob/master/lib/shared/network/local/cache_helper.dart"
    click QuoteModel "https://github.com/sonialr7iny/iquotes/blob/master/lib/models/quote_model.dart"
    click Styles "https://github.com/sonialr7iny/iquotes/blob/master/lib/shared/styles/styles.dart"
    click Colors "https://github.com/sonialr7iny/iquotes/blob/master/lib/shared/styles/colors.dart"
    click Components "https://github.com/sonialr7iny/iquotes/blob/master/lib/shared/components/components.dart"
    click Main "https://github.com/sonialr7iny/iquotes/blob/master/lib/main.dart"
    click Android "https://github.com/sonialr7iny/iquotes/blob/master/android/app/src/main/kotlin/com/example/qute_app/MainActivity.kt"
    click iOS "https://github.com/sonialr7iny/iquotes/blob/master/ios/Runner/AppDelegate.swift"
    click Web "https://github.com/sonialr7iny/iquotes/blob/master/web/index.html"
    click Windows "https://github.com/sonialr7iny/iquotes/blob/master/windows/runner/main.cpp"
    click Linux "https://github.com/sonialr7iny/iquotes/blob/master/linux/runner/main.cc"
    click MacOS "https://github.com/sonialr7iny/iquotes/blob/master/macos/Runner/MainFlutterWindow.swift"
```
