# hsd2747/portfolio architecture

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

- Interactive diagram: https://gitdiagram.com/hsd2747/portfolio
- Repository: https://github.com/hsd2747/portfolio

## Overview

##### Project Type and Purpose
- This is a cross-platform Flutter application (mobile: Android/iOS, web, desktop: Windows).
- It’s a “portfolio” app showcasing multiple project screens, built entirely in Dart/Flutter, embedding on each platform.

##### File Structure
Top-level directories:
- android, ios, web, windows → platform‐specific runner code that embeds the Flutter engine
- lib → core Dart/Flutter application
– components/ → reusable UI widgets and helper components
– models/ → data models (e.g. mouse_cursor_model)
– navigator/ → route definitions, parser, router logic
– theme/ → custom theme data and manager
– utils/ → utility classes (e.g. user_agent_manager)
– views/ → screen-level widgets, subdivided by “first_project,” “portfolio,” “second_project,” etc.
- test/ → widget tests
- pubspec.yaml → dependency & asset declarations

##### Extract Insights from README
- Confirms it’s a starter Flutter application.
- No backend or external API integrations called out—purely client UI/UX layers.

a. Main Components
1. Platform Runners (Android, iOS, Web, Windows)
2. Flutter Engine + Dart VM
3. Flutter Framework (widgets, rendering, gestures)
4. App Code Modules (lib/)
- Entry Point (main.dart)
- Navigator Layer (routes.dart, router.dart, route_parser.dart)
- Presentation Layer (views/ + components/)
- State/Data Models (models/)
- Theme Manager (theme/)
- Utilities (utils/)
5. Testing Layer (test/widget_test.dart)

b. Relationships & Interactions
- Each Platform Runner → embeds → Flutter Engine
- Flutter Engine ↔ Dart VM → runs → App Code
- main.dart → initializes → Theme Manager & Router
- Router → parses route → renders appropriate View
- Views → compose → Components
- Components ↔ Models/Utils (e.g. mouse cursor, user agent)
- Tests → drive → App Code in isolated environment

c. Architectural Patterns & Principles
- Layered structure: Platform → Engine → Framework → App modules
- Separation of Concerns:
– Routing isolated in navigator/
– Theming isolated in theme/
– UI widgets in views/ & components/
- Reusability: components/ houses cross-screen widgets
- Single Entry Point: main.dart

d. Key Technologies
- Flutter Engine + Dart VM
- Dart language
- Platform embedding code (Kotlin for Android, Swift/Obj-C for iOS, CMake/C++ for Windows, HTML/CSS/JS for Web)
- pubspec.yaml dependencies

##### Essential Elements (Don’t Overthink)
- Every high-level folder as a component.
- How data and control flow from platform up to the UI and between code modules.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Platform Runners
    subgraph "Platform Runners"
        Android["Android Runner"]:::platform
        iOS["iOS Runner"]:::platform
        Web["Web Runner"]:::platform
        Windows["Windows Runner"]:::platform
    end

    %% Engine & Framework
    Engine["Flutter Engine + Dart VM"]:::engine
    Framework["Flutter Framework"]:::engine

    %% App Code Modules
    subgraph "App Code (lib)" 
        Main["main.dart"]:::app
        subgraph Navigator
            Routes["routes.dart"]:::app
            Router["router.dart"]:::app
            Parser["route_parser.dart"]:::app
        end
        subgraph "Presentation Layer"
            Views["lib/views/"]:::app
            subgraph Components
                MouseEffect["mouse_effect_wrap.dart"]:::app
                SequenceAnim["sequence_animation.dart"]:::app
            end
        end
        Model["mouse_cursor_model.dart"]:::app
        subgraph Theme
            ThemeData["custom_theme_data.dart"]:::app
            ThemeMgr["theme_manager.dart"]:::app
        end
        Utils["user_agent_manager.dart"]:::app
    end

    %% Testing Layer
    Test["widget_test.dart"]:::test

    %% Connections
    Android -->|"embeds"| Engine
    iOS -->|"embeds"| Engine
    Web -->|"embeds"| Engine
    Windows -->|"embeds"| Engine

    Engine -->|"provides runtime to"| Framework
    Framework -->|"runs"| Main

    Main -->|"initializes"| ThemeMgr
    Main -->|"initializes"| Router

    Router -->|"uses"| Parser
    Parser -->|"parses route"| Routes
    Router -->|"navigates to"| Views

    Views -->|"composes"| MouseEffect
    Views -->|"composes"| SequenceAnim

    MouseEffect <-->|"binds to"| Model
    SequenceAnim <-->|"binds to"| Model
    MouseEffect <-->|"uses"| Utils
    SequenceAnim <-->|"uses"| Utils

    Test -->|"drives"| Main

    %% Click Events
    click Android "https://github.com/hsd2747/portfolio/tree/main/android/"
    click iOS "https://github.com/hsd2747/portfolio/tree/main/ios/"
    click Web "https://github.com/hsd2747/portfolio/tree/main/web/"
    click Windows "https://github.com/hsd2747/portfolio/tree/main/windows/"
    click Main "https://github.com/hsd2747/portfolio/blob/main/lib/main.dart"
    click Routes "https://github.com/hsd2747/portfolio/blob/main/lib/navigator/routes.dart"
    click Router "https://github.com/hsd2747/portfolio/blob/main/lib/navigator/router.dart"
    click Parser "https://github.com/hsd2747/portfolio/blob/main/lib/navigator/route_parser.dart"
    click Views "https://github.com/hsd2747/portfolio/tree/main/lib/views/"
    click MouseEffect "https://github.com/hsd2747/portfolio/blob/main/lib/components/mouse_effect_wrap.dart"
    click SequenceAnim "https://github.com/hsd2747/portfolio/blob/main/lib/components/sequence_animation.dart"
    click Model "https://github.com/hsd2747/portfolio/blob/main/lib/models/mouse_cursor_model.dart"
    click ThemeData "https://github.com/hsd2747/portfolio/blob/main/lib/theme/custom_theme_data.dart"
    click ThemeMgr "https://github.com/hsd2747/portfolio/blob/main/lib/theme/theme_manager.dart"
    click Utils "https://github.com/hsd2747/portfolio/blob/main/lib/utils/user_agent_manager.dart"
    click Test "https://github.com/hsd2747/portfolio/blob/main/test/widget_test.dart"

    %% Styles
    classDef platform fill:#e0e0e0,stroke:#888,stroke-width:1px
    classDef engine fill:#d0e6ff,stroke:#6699cc,stroke-width:1px
    classDef app fill:#e0ffe0,stroke:#66cc66,stroke-width:1px
    classDef test fill:#ffe0b3,stroke:#cc9966,stroke-width:1px
```
