# farazsd/interest_calculator architecture

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

- Interactive diagram: https://gitdiagram.com/farazsd/interest_calculator
- Repository: https://github.com/farazsd/interest_calculator

## Overview

##### Project type and purpose
- This is a cross-platform Flutter application (“calculator_app”) that provides at least two screens: a home screen and an interest calculation screen.
- It targets mobile (Android, iOS), desktop (macOS, Linux, Windows), and web, using a single Dart codebase under `lib/`.

##### File structure
- Top-level directories:
- android/ – Android embedding code (`MainActivity.kt`, Gradle files)
- ios/, macos/, linux/, windows/ – Native runner projects for each platform (AppDelegate.swift, `main.cc`, CMakeLists, etc.)
- web/ – Web entrypoint (`index.html`, `manifest.json`)
- lib/ – The entire Dart UI & business logic:
– `main.dart` (app entrypoint)
– `home/home_screen.dart` (home UI)
– `home/intrest_screen.dart` (interest calculation UI & logic)
- assets/ – Static resources (`rate_interest.json`)
- test/ – Automated widget test (`widget_test.dart`)
- pubspec.yaml – Dependency & asset declarations
- .github/workflows – CI configuration (actions.yml)

##### README
- Default Flutter boilerplate README: confirms this is a starter Flutter project, no bespoke architecture docs.

##### Main components & interactions
a. Components
1. Presentation Layer (Dart/Flutter Widgets in `lib/`)
2. Business Logic (Dart code in `intrest_screen.dart`)
3. Asset Loader (reads `assets/rate_interest.json` via Flutter’s AssetBundle)
4. Flutter Framework & Engine (renders UI, handles input)
5. Platform Embedders (per-platform host code):
– Android Embedder (`android/app/src/.../MainActivity.kt`)
– iOS Embedder (`ios/Runner/AppDelegate.swift`)
– macOS Embedder (`macos/Runner/AppDelegate.swift`)
– Linux Embedder (`linux/main.cc`, `generated_plugin_registrant.cc`)
– Windows Embedder (`windows/runner/main.cpp`, etc.)
– Web Embedder (`web/index.html`, web engine)
6. CI/CD Workflow (`.github/workflows/actions.yml`)

b. Relationships & data flow
- UI Widgets ←→ Business Logic ←→ Asset Loader
- UI/Logic → Flutter Framework → Flutter Engine
- Engine ↔ Native Embedder (via platform channels for plugins, input events, rendering surfaces)
- Native Embedder → OS window / runtime
- CI Workflow → build/test pipelines on GitHub

c. Architectural patterns
- Single-codebase multi-platform layering
- Separation of concerns: Presentation vs. Logic vs. Platform embedding
- Flutter’s reactive UI pattern (widgets rebuild on state changes)

d. Key technologies
- Dart & Flutter SDK
- Flutter Engine (C++)
- Platform toolchains (Gradle/Android SDK, Xcode, CMake for Linux/Windows)
- AssetBundle for JSON data
- GitHub Actions for CI

##### Diagramming recommendations
[Presentation Layer]
[Business Logic]
[Asset Loader]
[Flutter Framework & Engine]
[Android Embedder] [iOS Embedder] [macOS Embedder] [Linux Embedder] [Windows Embedder] [Web Embedder]
- Presentation → Business Logic → Asset Loader
- Presentation/Logic → Framework → Engine
- Engine ↔ each Embedder → OS
- Blue = Dart code (UI + Logic)
- Green = Asset subsystem
- Gray = Flutter Framework & Engine
- Orange = Native Embedders

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Node definitions
    CI["CI/CD Workflow"]:::ci
    Entry["App Entry Point\nmain.dart"]:::dart
    Presentation["Presentation Layer\n(Flutter Widgets)"]:::dart
    Home["Home Screen UI"]:::dart
    Interest["Interest Calculation\nUI & Logic"]:::dart
    Business["Business Logic"]:::dart
    Asset["Asset Loader\nrate_interest.json"]:::asset
    Framework["Flutter Framework"]:::framework
    Engine["Flutter Engine"]:::framework

    subgraph "Platform Embedders"
        Android["Android Embedder"]:::embedder
        iOS["iOS Embedder"]:::embedder
        macOS["macOS Embedder"]:::embedder
        subgraph "Linux Embedder"
            LinuxMain["main.cc"]:::embedder
            LinuxReg["generated_plugin_registrant.cc"]:::embedder
        end
        subgraph "Windows Embedder"
            WinMain["main.cpp"]:::embedder
            WinReg["generated_plugin_registrant.cc"]:::embedder
        end
        Web["Web Embedder"]:::embedder
    end

    %% Connections
    CI -->|"triggers build/test"| Entry
    Entry -->|"initializes app"| Presentation
    Presentation -->|"renders UI"| Home
    Presentation -->|"renders UI"| Interest
    Home -->|"invokes logic"| Business
    Interest -->|"invokes logic"| Business
    Business -->|"reads asset"| Asset
    Presentation -->|"render request"| Framework
    Business -->|"logical updates"| Framework
    Framework -->|"renders frames"| Engine
    Engine <-->|"platform channels & events"| Android
    Engine <-->|"platform channels & events"| iOS
    Engine <-->|"platform channels & events"| macOS
    Engine <-->|"platform channels & events"| LinuxMain
    Engine <-->|"platform channels & events"| LinuxReg
    Engine <-->|"platform channels & events"| WinMain
    Engine <-->|"platform channels & events"| WinReg
    Engine <-->|"platform channels & events"| Web

    %% Click events
    click CI "https://github.com/farazsd/interest_calculator/blob/master/.github/workflows/actions.yml"
    click Entry "https://github.com/farazsd/interest_calculator/blob/master/lib/main.dart"
    click Presentation "https://github.com/farazsd/interest_calculator/tree/master/lib/"
    click Home "https://github.com/farazsd/interest_calculator/blob/master/lib/home/home_screen.dart"
    click Interest "https://github.com/farazsd/interest_calculator/blob/master/lib/home/intrest_screen.dart"
    click Asset "https://github.com/farazsd/interest_calculator/blob/master/assets/rate_interest.json"
    click Android "https://github.com/farazsd/interest_calculator/blob/master/android/app/src/main/kotlin/com/example/calculator_app/MainActivity.kt"
    click iOS "https://github.com/farazsd/interest_calculator/blob/master/ios/Runner/AppDelegate.swift"
    click macOS "https://github.com/farazsd/interest_calculator/blob/master/macos/Runner/AppDelegate.swift"
    click LinuxMain "https://github.com/farazsd/interest_calculator/blob/master/linux/main.cc"
    click LinuxReg "https://github.com/farazsd/interest_calculator/blob/master/linux/flutter/generated_plugin_registrant.cc"
    click WinMain "https://github.com/farazsd/interest_calculator/blob/master/windows/runner/main.cpp"
    click WinReg "https://github.com/farazsd/interest_calculator/blob/master/windows/flutter/generated_plugin_registrant.cc"
    click Web "https://github.com/farazsd/interest_calculator/blob/master/web/index.html"

    %% Styles
    classDef dart fill:#D0E1FF,stroke:#0366D6,color:#0366D6;
    classDef asset fill:#E8F5E9,stroke:#2E7D32,color:#2E7D32;
    classDef framework fill:#EEEEEE,stroke:#424242,color:#424242;
    classDef embedder fill:#FFF3E0,stroke:#EF6C00,color:#E65100;
    classDef ci fill:#F3E5F5,stroke:#8E24AA,color:#6A1B9A;
```
