# kuneosu/mintoners architecture

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

- Interactive diagram: https://gitdiagram.com/kuneosu/mintoners
- Repository: https://github.com/kuneosu/mintoners

## Overview

##### Main Components

a) Application Layer:
- MainActivity as the entry point
- SplashActivity for initial loading
- InstructionActivity for user guidance
- MatchActivity for match management

b) UI Layer (Fragment Structure):
- Home Module (HomeFragment)
- Match Module (MatchInfoFragment, MatchPlayerFragment, MatchGameFragment, MatchMainFragment)
- Settings Module (SettingsFragment)
- Notice Module (NoticeFragment)

c) Data Layer:
- Local Storage (Room Database)
- AppDatabase
- MainDao
- Remote Storage
- GitHub API Service (for notices)
- RetrofitClient

d) Repository Layer:
- HomeRepository
- MatchRepository

e) ViewModel Layer:
- HomeViewModel
- MatchViewModel

##### Relationships and Data Flow

- User interaction flow through Activities and Fragments
- Data flow between ViewModels and Repositories
- Database interactions
- API calls to GitHub for notices

##### Specific Implementation Details

- DI implementation using Hilt
- Navigation components
- Custom Views and Dialogs
- Data Models (Match, Player, Game, Notice)

##### Architecture Pattern

MVVM architecture:
- View Layer (Activities/Fragments)
- ViewModel Layer
- Model Layer (Repositories/Data Sources)

##### External Dependencies

Integration with:
- Firebase Remote Config
- GitHub API
- Material Design Components

**[UI Layer (Activities/Fragments)]**
- ↕
**[ViewModel Layer]**
- ↕
**[Repository Layer]**
- ↕
**[Data Layer (Local/Remote)]**

Key Considerations:

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef ui fill:#3498db,color:white
    classDef data fill:#2ecc71,color:white
    classDef logic fill:#f1c40f,color:black
    classDef utility fill:#95a5a6,color:white

    %% Legend
    subgraph Legend
        UI[UI Components]:::ui
        Data[Data Components]:::data
        Logic[Business Logic]:::logic
        Util[Utilities]:::utility
    end

    %% Application Layer
    subgraph Application
        MA[MainActivity]
        SA[SplashActivity]
        IA[InstructionActivity]
        MTA[MatchActivity]
    end

    %% UI Layer
    subgraph Fragments
        HF[HomeFragment]
        MIF[MatchInfoFragment]
        MPF[MatchPlayerFragment]
        MGF[MatchGameFragment]
        MMF[MatchMainFragment]
        SF[SettingsFragment]
        NF[NoticeFragment]
    end

    %% ViewModel Layer
    subgraph ViewModels
        HVM[HomeViewModel]
        MVM[MatchViewModel]
    end

    %% Repository Layer
    subgraph Repositories
        HR[HomeRepository]
        MR[MatchRepository]
    end

    %% Data Layer
    subgraph "Data Layer"
        subgraph "Local Storage"
            AD[AppDatabase]
            MD[MainDao]
        end
        
        subgraph "Remote Storage"
            GAS[GitHubApiService]
            RC[RetrofitClient]
        end

        subgraph "Data Models"
            Match[Match]
            Player[Player]
            Game[Game]
            Notice[Notice]
        end
    end

    %% Dependency Injection
    DM[DatabaseModule]:::utility

    %% Relationships
    MA --> HF & MTA
    SA --> MA
    IA --> MA
    MTA --> MIF & MPF & MGF & MMF
    HF --> HVM
    MIF & MPF & MGF & MMF --> MVM
    HVM --> HR
    MVM --> MR
    HR --> AD & GAS
    MR --> AD
    AD --> MD
    GAS --> RC

    %% Click Events
    click MA "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/MainActivity.kt"
    click SA "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/view/SplashActivity.kt"
    click IA "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/view/InstructionActivity.kt"
    click MTA "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/view/MatchActivity.kt"
    click HF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/HomeFragment.kt"
    click MIF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/MatchInfoFragment.kt"
    click MPF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/MatchPlayerFragment.kt"
    click MGF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/MatchGameFragment.kt"
    click MMF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/MatchMainFragment.kt"
    click SF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/SettingsFragment.kt"
    click NF "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/fragments/NoticeFragment.kt"
    click AD "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/local/database/AppDatabase.kt"
    click MD "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/local/dao/MainDao.kt"
    click GAS "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/remote/api/GitHubApiService.kt"
    click RC "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/remote/api/RetrofitClient.kt"
    click HR "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/repository/HomeRepository.kt"
    click MR "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/repository/MatchRepository.kt"
    click HVM "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/viewmodel/HomeViewModel.kt"
    click MVM "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/ui/viewmodel/MatchViewModel.kt"
    click Match "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/model/Match.kt"
    click Player "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/model/Player.kt"
    click Game "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/model/Game.kt"
    click Notice "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/data/model/Notice.kt"
    click DM "https://github.com/Kuneosu/Mintoners/blob/main/app/src/main/java/com/kuneosu/mintoners/di/DatabaseModule.kt"

    %% Style Applications
    class MA,SA,IA,MTA,HF,MIF,MPF,MGF,MMF,SF,NF ui
    class AD,MD,GAS,RC,Match,Player,Game,Notice data
    class HVM,MVM,HR,MR logic
```
