# project-qriz/ios architecture

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

- Interactive diagram: https://gitdiagram.com/project-qriz/ios
- Repository: https://github.com/project-qriz/ios

## Overview

##### Project Type and Purpose
- QRIZ is a native iOS “full-stack” examination prep app written in Swift.
- It uses MVVM for presentation, a Coordinator pattern for navigation, and calls out to remote RESTful APIs for auth, exam data, daily quizzes, onboarding surveys, etc.

##### High‐Level Layer Breakdown
a. App / Life‐Cycle Layer (top)
- Files: AppDelegate.swift, SceneDelegate.swift in QRIZ/App
- Responsibilities: Bootstraps the application, sets up dependency injection, instantiates the AppCoordinator, hands off control to the first navigation graph.
b. Coordinator Layer
- Files: AppCoordinator.swift (root), plus SplashCoordinator, LoginCoordinator, SignUpCoordinator, OnboardingCoordinator, HomeCoordinator, ConceptBookCoordinator, DailyCoordinator, ExamCoordinator, MistakeNoteCoordinator, MyPageCoordinator, TabBarCoordinator in QRIZ/Coordinator and QRIZ/Feature/*/*Coordinator.swift.
c. Presentation Layer
- Folders: QRIZ/Feature/* containing ViewControllers and ViewModels
- Patterns: ViewController <> ViewModel binding via Combine publishers (e.g., using Combine+ extension) or NotificationCenter. Each ViewModel exposes Inputs (user actions) and Outputs (UI state).
- Example: LoginViewController ↔ LoginViewModel; DailyTestViewController ↔ DailyTestViewModel; ExamListViewController ↔ ExamListViewModel.
d. Domain Layer
- Files: Pure business models in QRIZ/Utils/Model and Definitions in QRIZ/Utils/Types
- Responsibilities: Core entities (SubjectType, DailyLearnType, QuestionData, ScoreGraphData, etc.), validation logic, use‐case orchestration.
- Flow: ViewModel calls a use‐case function (e.g., “submitDailyAnswer” or “fetchExamScore”), passing domain models and receiving domain results or errors.
e. Data / Networking Layer
- Folders: Network/Base, Network/DTOs, Network/Service/Auth, Daily, Exam, ExamSchedule, Onboarding, UserInfo
- Components:
– NetworkRequest/NetworkManager handles HTTPMethod, headers, URLSession calls.
– DTOs mirror JSON payloads (e.g., LoginRequest, DailySubmitRequest, ExamResultRequest).
– Services wrap calls and transform DTOs to domain models or throw NetworkError.
- Flow: ViewModel → Service (e.g., LoginService.login) → NetworkManager → HTTP response → DTO → mapping → Domain entity → returns to ViewModel.
f. Resources / Supporting Layer (bottom)

##### Main Components & Interactions

- AppDelegate → AppCoordinator
- AppCoordinator → Feature Coordinators
- Feature Coordinator → ViewController
- ViewModel → Domain Use Cases
- Use Cases → Service APIs
- Services → NetworkManager → External API
- NetworkManager → DTO → Service → Domain → ViewModel

##### Architectural Patterns & Principles
- MVVM: clear separation of UI and business logic
- Coordinator pattern: decouples navigation logic from view controllers
- Dependency injection at app bootstrapping
- Single‐responsibility: each service handles one API group; each ViewModel handles one screen flow
- Error propagation: NetworkError bubbles up to ViewModel for user‐friendly alerts (via a Publisher)

##### Essential Detail
- Every layer’s critical responsibilities and file associations.
- How DTOs map to domain models and propagate through the system.
- MVVM + Coordinator combo.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Six Layers
    subgraph "App / Life-Cycle Layer"
        direction TB
        AppDelegate["AppDelegate.swift"]:::lifecycle
        SceneDelegate["SceneDelegate.swift"]:::lifecycle
    end

    subgraph "Coordinator Layer"
        direction TB
        AppCoordinator["AppCoordinator"]:::coordinator
        TabBarCoordinator["TabBarCoordinator"]:::coordinator
        LoginCoordinator["LoginCoordinator"]:::coordinator
        OnboardingCoordinator["OnboardingCoordinator"]:::coordinator
    end

    subgraph "Presentation Layer"
        direction TB
        LoginVC["LoginViewController"]:::ui
        LoginVM["LoginViewModel"]:::presentation
        DailyVC["DailyTestViewController"]:::ui
        DailyVM["DailyResultViewModel"]:::presentation
        ExamVC["ExamListViewController"]:::ui
        ExamVM["ExamTestViewModel"]:::presentation
    end

    subgraph "Domain Layer"
        direction TB
        QuestionData["QuestionData"]:::domain
        SurveyCheckList["SurveyCheckList"]:::domain
        SubjectType["SubjectType"]:::domain
        FindAccountType["FindAccountType"]:::domain
    end

    subgraph "Data / Networking Layer"
        direction TB
        NetworkManager["NetworkManager"]:::service
        LoginService["LoginService"]:::service
        DailyService["DailyService"]:::service
        LoginRequest["LoginRequest"]:::dto
        DailySubmitRequest["DailySubmitRequest"]:::dto
        ExamResultRequest["ExamResultRequest"]:::dto
    end

    subgraph "Resources / Supporting Layer"
        direction TB
        Assets["Assets.xcassets"]:::resources
        InfoPlist["Info.plist"]:::resources
    end

    %% External API
    ExternalAPI["External API"]:::external

    %% Arrows: Control Flow (dashed)
    AppDelegate -->|bootstraps| AppCoordinator
    SceneDelegate -->|initializes| AppCoordinator
    AppCoordinator -.->|manages| LoginCoordinator
    AppCoordinator -.->|manages| OnboardingCoordinator
    AppCoordinator -.->|manages| TabBarCoordinator
    LoginCoordinator -.->|navigates to| LoginVC
    OnboardingCoordinator -.->|navigates to| LoginVC
    TabBarCoordinator -.->|navigates to| ExamVC

    %% Arrows: Data Flow (solid)
    LoginVC -->|"binds"| LoginVM
    DailyVC -->|"binds"| DailyVM
    ExamVC -->|"binds"| ExamVM
    LoginVM -->|"calls use-case"| QuestionData
    DailyVM -->|"calls use-case"| SurveyCheckList
    ExamVM -->|"calls use-case"| SubjectType
    LoginVM -->|"uses"| LoginService
    DailyVM -->|"uses"| DailyService
    LoginService -->|"requests"| NetworkManager
    DailyService -->|"requests"| NetworkManager
    NetworkManager -->|"HTTP calls"| ExternalAPI
    ExternalAPI -->|"response DTOs"| LoginRequest
    ExternalAPI -->|"response DTOs"| DailySubmitRequest
    ExternalAPI -->|"response DTOs"| ExamResultRequest
    LoginRequest -->|"maps to"| QuestionData
    DailySubmitRequest -->|"maps to"| SurveyCheckList
    ExamResultRequest -->|"maps to"| SubjectType

    %% Resources flow
    Assets -->|provides| LoginVC
    InfoPlist -->|configures| AppDelegate

    %% Legend
    subgraph "Legend"
        direction LR
        UI["UI Controller"]:::ui
        PM["ViewModel/Coordinator"]:::presentation
        DM["Domain Model/Use Case"]:::domain
        SV["Service/Client"]:::service
        DTO["DTO"]:::dto
        EXT["External API"]:::external
        RS["Resources"]:::resources
    end

    %% Click Events
    click AppDelegate "https://github.com/project-qriz/ios/blob/develop/QRIZ/App/AppDelegate.swift"
    click SceneDelegate "https://github.com/project-qriz/ios/blob/develop/QRIZ/App/SceneDelegate.swift"
    click AppCoordinator "https://github.com/project-qriz/ios/blob/develop/QRIZ/Coordinator/AppCoordinator.swift"
    click TabBarCoordinator "https://github.com/project-qriz/ios/blob/develop/QRIZ/Coordinator/TabBarCoordinator.swift"
    click LoginCoordinator "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Login/LoginCoordinator.swift"
    click OnboardingCoordinator "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Onboarding/OnboardingCoordinator.swift"
    click LoginVC "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Login/ViewController/LoginViewController.swift"
    click LoginVM "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Login/ViewModel/LoginViewModel.swift"
    click DailyVC "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Daily/DailyTest/ViewController/DailyTestViewController.swift"
    click DailyVM "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Daily/DailyResult/ViewModel/DailyResultViewModel.swift"
    click ExamVC "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Exam/ExamList/ViewController/ExamListViewController.swift"
    click ExamVM "https://github.com/project-qriz/ios/blob/develop/QRIZ/Feature/Exam/ExamTest/ViewModel/ExamTestViewModel.swift"
    click QuestionData "https://github.com/project-qriz/ios/blob/develop/QRIZ/Utils/Model/TestModel/QuestionData.swift"
    click SurveyCheckList "https://github.com/project-qriz/ios/blob/develop/QRIZ/Utils/Model/OnboardingModel/SurveyCheckList.swift"
    click SubjectType "https://github.com/project-qriz/ios/blob/develop/QRIZ/Utils/Model/SubjectType.swift"
    click FindAccountType "https://github.com/project-qriz/ios/blob/develop/QRIZ/Utils/Types/FindAccountType.swift"
    click NetworkManager "https://github.com/project-qriz/ios/blob/develop/Network/Base/NetworkManager.swift"
    click LoginService "https://github.com/project-qriz/ios/blob/develop/Network/Service/Auth/LoginService.swift"
    click DailyService "https://github.com/project-qriz/ios/blob/develop/Network/Service/Daily/DailyService.swift"
    click LoginRequest "https://github.com/project-qriz/ios/blob/develop/Network/DTOs/Auth/LoginRequest.swift"
    click DailySubmitRequest "https://github.com/project-qriz/ios/blob/develop/Network/DTOs/Daily/DailySubmitRequest.swift"
    click ExamResultRequest "https://github.com/project-qriz/ios/blob/develop/Network/DTOs/Exam/ExamResultRequest.swift"
    click Assets "https://github.com/project-qriz/ios/blob/develop/QRIZ/Resources/Assets.xcassets"
    click InfoPlist "https://github.com/project-qriz/ios/blob/develop/QRIZ/SupportingFiles/Info.plist"

    %% Styles
    classDef lifecycle fill:#CCE5FF,stroke:#004080;
    classDef coordinator fill:#E6CCFF,stroke:#660099;
    classDef presentation fill:#FFE6CC,stroke:#994C00;
    classDef ui fill:#FFCCCC,stroke:#990000,stroke-width:2px,shape:roundrectangle;
    classDef domain fill:#CCFFCC,stroke:#006600,shape:diamond;
    classDef service fill:#CCCCFF,stroke:#000099,shape:cylinder;
    classDef dto fill:#FFFFCC,stroke:#999900,shape:cylinder;
    classDef resources fill:#F2F2F2,stroke:#666666,shape:folder;
    classDef external fill:#FFD9E6,stroke:#CC0066,shape:cloud;
```
