# tomas2870/habits architecture

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

- Interactive diagram: https://gitdiagram.com/tomas2870/habits
- Repository: https://github.com/tomas2870/habits

## Overview

##### Main components
- App entry point: ProjectApp.swift (SwiftUI’s @main App struct)
- UI layer (Views folder)
- Presentation / business-logic layer (ViewModels folder)
- Data layer (Models folder + Firebase)
- Extensions & Utilities (Other/Extensions.swift)
- External services: Firebase Authentication, Firestore Database

##### Establish relationships & data flow
a. User taps UI in a View (e.g., LoginView.swift)
b. View binds to a corresponding ViewModel (e.g., LoginViewViewModel.swift)
c. ViewModel performs logic (validates input) and calls Firebase APIs
d. Firebase Auth or Firestore returns success/error
e. ViewModel updates its @Published properties
f. View automatically updates through SwiftUI bindings

##### Architectural patterns & principles
- MVVM: separate UI (Views), state & logic (ViewModels), data definitions (Models)
- Single source of truth for state in ViewModels
- Dependency inversion: ViewModels depend on abstractions (protocols) for Firebase calls
- Unidirectional data flow: View → ViewModel → Service → ViewModel → View

##### Technologies & libraries to annotate
- SwiftUI (Views layer)
- Combine (used implicitly via @Published in ViewModels)
- FirebaseAuth (for user registration/login)
- Firestore (for storing Habit and User data)
- Xcode asset catalogs (Other/Assets.xcassets)

##### Final checklist
[ ] ProjectApp entry point & routing
[ ] All major Views & their corresponding ViewModels
[ ] Models used by ViewModels (Habit, User)
[ ] Arrowed interactions between layers
[ ] Firebase Auth & Firestore represented as external services
[ ] Call out architectural pattern (MVVM) in a corner

## Diagram (Mermaid)

```mermaid
graph TB
    %% Entry point
    ProjectApp["ProjectApp @main"]:::entrypoint

    subgraph "iOS App (SwiftUI)"
        subgraph "Views"
            LoginView["LoginView"]:::views
            RegisterView["RegisterView"]:::views
            MainView["MainView"]:::views
            HabitsView["HabitsView"]:::views
            GoalsView["GoalsView"]:::views
            ProfileView["ProfileView"]:::views
            NewHabitView["NewHabitView"]:::views
            IndividualHabitView["IndividualHabitView"]:::views
            AHButton["AHButton"]:::views
            HeaderView["HeaderView"]:::views
            SwiftUIView["SwiftUIView"]:::views
        end

        subgraph "ViewModels"
            LoginVM["LoginViewViewModel"]:::viewmodels
            RegisterVM["RegisterViewViewModel"]:::viewmodels
            MainVM["MainViewViewModel"]:::viewmodels
            HabitsVM["HabitsViewViewModel"]:::viewmodels
            GoalsVM["GoalsViewViewModel"]:::viewmodels
            ProfileVM["ProfileViewViewModel"]:::viewmodels
            NewHabitVM["NewHabitViewViewModel"]:::viewmodels
            IndividualHabitVM["IndividualHabitViewViewModel"]:::viewmodels
        end

        subgraph "Models & Utilities"
            Habit["Habit model"]:::models
            User["User model"]:::models
            Extensions["Extensions & Utilities"]:::utils
            Assets["Assets.xcassets"]:::utils
            PreviewAssets["Preview Assets.xcassets"]:::utils
            Config["GoogleService-Info.plist"]:::utils
            README["DESIGN.md"]:::utils
        end
    end

    subgraph "Firebase"
        Auth["Auth"]:::external
        Firestore["Firestore"]:::external
    end

    %% Routing
    ProjectApp -->|"launches"| LoginView
    ProjectApp -->|"if authenticated"| MainView

    %% View to ViewModel bindings
    LoginView -->|"binds"| LoginVM
    RegisterView -->|"binds"| RegisterVM
    MainView -->|"binds"| MainVM
    HabitsView -->|"binds"| HabitsVM
    GoalsView -->|"binds"| GoalsVM
    ProfileView -->|"binds"| ProfileVM
    NewHabitView -->|"binds"| NewHabitVM
    IndividualHabitView -->|"binds"| IndividualHabitVM

    %% MainView aggregates sub-ViewModels
    MainVM -->|"contains"| HabitsVM
    MainVM -->|"contains"| GoalsVM
    MainVM -->|"contains"| ProfileVM
    MainVM -->|"contains"| NewHabitVM
    MainVM -->|"contains"| IndividualHabitVM

    %% ViewModels calling Firebase
    LoginVM -->|"signIn(email,password)"| Auth
    RegisterVM -->|"createUser(email,password)"| Auth
    HabitsVM -->|"fetch/update/add/delete Habit"| Firestore
    GoalsVM -->|"fetch/update/add/delete Goal"| Firestore
    ProfileVM -->|"fetch/update User profile"| Firestore
    NewHabitVM -->|"add Habit"| Firestore
    IndividualHabitVM -->|"update/delete Habit"| Firestore

    %% Firebase callbacks
    Auth -->|"callback(success/failure)"| LoginVM
    Auth -->|"callback(success/failure)"| RegisterVM
    Firestore -->|"data/error"| HabitsVM
    Firestore -->|"data/error"| GoalsVM
    Firestore -->|"data/error"| ProfileVM
    Firestore -->|"data/error"| NewHabitVM
    Firestore -->|"data/error"| IndividualHabitVM

    %% ViewModels to Models mapping
    HabitsVM -->|"maps data to"| Habit
    GoalsVM -->|"maps data to"| Habit
    IndividualHabitVM -->|"maps data to"| Habit
    ProfileVM -->|"maps data to"| User

    %% Utilities usage
    Extensions -->|"used by"| LoginVM
    Extensions -->|"used by"| RegisterVM
    Extensions -->|"used by"| MainVM
    Extensions -->|"used by"| HabitsVM

    %% Click Events
    click ProjectApp "https://github.com/tomas2870/habits/blob/main/Other/ProjectApp.swift"
    click LoginView "https://github.com/tomas2870/habits/blob/main/Views/LoginView.swift"
    click RegisterView "https://github.com/tomas2870/habits/blob/main/Views/RegisterView.swift"
    click MainView "https://github.com/tomas2870/habits/blob/main/Views/MainView.swift"
    click HabitsView "https://github.com/tomas2870/habits/blob/main/Views/HabitsView.swift"
    click GoalsView "https://github.com/tomas2870/habits/blob/main/Views/GoalsView.swift"
    click ProfileView "https://github.com/tomas2870/habits/blob/main/Views/ProfileView.swift"
    click NewHabitView "https://github.com/tomas2870/habits/blob/main/Views/NewHabitView.swift"
    click IndividualHabitView "https://github.com/tomas2870/habits/blob/main/Views/IndividualHabitView.swift"
    click AHButton "https://github.com/tomas2870/habits/blob/main/Views/AHButton.swift"
    click HeaderView "https://github.com/tomas2870/habits/blob/main/Views/HeaderView.swift"
    click SwiftUIView "https://github.com/tomas2870/habits/blob/main/Views/SwiftUIView.swift"
    click LoginVM "https://github.com/tomas2870/habits/blob/main/ViewModels/LoginViewViewModel.swift"
    click RegisterVM "https://github.com/tomas2870/habits/blob/main/ViewModels/RegisterViewViewModel.swift"
    click MainVM "https://github.com/tomas2870/habits/blob/main/ViewModels/MainViewViewModel.swift"
    click HabitsVM "https://github.com/tomas2870/habits/blob/main/ViewModels/HabitsViewViewModel.swift"
    click GoalsVM "https://github.com/tomas2870/habits/blob/main/ViewModels/GoalsViewViewModel.swift"
    click ProfileVM "https://github.com/tomas2870/habits/blob/main/ViewModels/ProfileViewViewModel.swift"
    click NewHabitVM "https://github.com/tomas2870/habits/blob/main/ViewModels/NewHabitViewViewModel.swift"
    click IndividualHabitVM "https://github.com/tomas2870/habits/blob/main/ViewModels/IndividualHabitViewViewModel.swift"
    click Habit "https://github.com/tomas2870/habits/blob/main/Models/Habit.swift"
    click User "https://github.com/tomas2870/habits/blob/main/Models/User.swift"
    click Config "https://github.com/tomas2870/habits/blob/main/GoogleService-Info.plist"
    click Extensions "https://github.com/tomas2870/habits/blob/main/Other/Extensions.swift"
    click Assets "https://github.com/tomas2870/habits/blob/main/Other/Assets.xcassets"
    click PreviewAssets "https://github.com/tomas2870/habits/blob/main/Preview Content/Preview Assets.xcassets"
    click README "https://github.com/tomas2870/habits/blob/main/README/DESIGN.md"

    %% Styles
    classDef views fill:#D0E8FF,stroke:#333,stroke-width:1px;
    classDef viewmodels fill:#D0FFD6,stroke:#333,stroke-width:1px;
    classDef models fill:#FFF7C0,stroke:#333,stroke-width:1px;
    classDef utils fill:#E0E0E0,stroke:#333,stroke-width:1px;
    classDef external fill:#FFCCCC,stroke:#333,stroke-width:1px;
    classDef entrypoint fill:#EFCFFB,stroke:#333,stroke-width:1px;
```
