# mygarden23/mygarden architecture

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

- Interactive diagram: https://gitdiagram.com/mygarden23/mygarden
- Repository: https://github.com/mygarden23/mygarden

## Overview

##### Project type and purpose
- This is a full-stack mobile application (“MyGarden”) built for Android using Kotlin and Jetpack Compose.
- It provides user authentication, cloud-backed data storage, photo capture and analysis, offline support, and push notifications to help users track and care for their plants.

##### File structure
- app/src/main/java/com/android/mygarden – Contains the core Android app code:
– ui/… (Compose screens, navigation, theming)
– model/… (domain entities, repositories, mapper, health calculator)
– MainActivity.kt (entry point)
- app/src/test & androidTest – Unit and instrumentation tests for every layer (UI, ViewModels, Repositories).
- build scripts (build.gradle.kts), CI workflows (.github/workflows), Firebase config (.firebaserc, firebase.json).
- Key top-level concerns: authentication, plant data, profile data, camera integration, local/offline mode, notifications.

##### README for additional insights
- Split App Model: managed auth, document database (Firestore), file storage, notification service (FCM).
- Multi-user support & social features (friends, leaderboard).
- Core feature: camera sensor for photo insights.
- Offline mode with continued access to garden data and notifications.

##### Main components and interactions
a. Client App
- UI Layer (Jetpack Compose screens + Navigation host)
- ViewModels (one per screen: SignIn, Camera, Garden, EditPlant, PlantInfo, Profile, Popup)
- Repositories (AuthRepository, PlantsRepository, ProfileRepository) with base, local, Firestore implementations
- Domain Models (Plant, Profile) and utilities (PlantHealthCalculator)
- Local Persistence (Firestore offline cache + optional local data store)
- Camera module (CameraViewModel + helper classes)
- Notification scheduler (local Android notifications)
b. External Cloud Services
- Firebase Authentication (email/password, Google sign-in)
- Google Sign-In OAuth
- Firebase Firestore (document database for plant and profile data, offline persistence)
- Firebase Storage (binary storage for plant photos)
- Firebase Cloud Messaging (push notifications for care reminders)
c. Device Resources
- Camera sensor (photo capture)
- Local notification manager
d. CI/CD Pipeline
- GitHub Actions (APK build, CI tests)
- Firebase emulator & instrumentation test environment

##### Architectural patterns & design principles
- MVVM (UI → ViewModel → Repository → Data source)
- Repository pattern with provider/factory to switch between local and Firestore implementations
- Single Activity + Compose Navigation (AppNavHost)
- Dependency injection (manual via Provider classes)
- Offline-first using Firestore’s local persistence + WorkManager or AlarmManager for notifications
- Modular separation: UI, domain, data

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% App Layer
    subgraph "MyGarden App"
        direction TB
        subgraph "UI Layer"
            direction TB
            MainActivity["MainActivity"]:::presentation
            NavHost["AppNavHost"]:::presentation
            SignInScreen["SignInScreen"]:::presentation
            CameraScreen["CameraScreen"]:::presentation
            GardenScreen["GardenScreen"]:::presentation
            EditPlantScreen["EditPlantScreen"]:::presentation
            PlantInfoScreen["PlantInfoScreen"]:::presentation
            PopupScreen["PopupScreen"]:::presentation
            ProfileScreens["ProfileScreens"]:::presentation
            UITheme["UI Theme"]:::presentation
        end

        subgraph "ViewModels"
            direction TB
            SignInVM["SignInViewModel"]:::presentation
            CameraVM["CameraViewModel"]:::presentation
            GardenVM["GardenViewModel"]:::presentation
            EditPlantVM["EditPlantViewModel"]:::presentation
            PlantInfoVM["PlantInfoViewModel"]:::presentation
            PopupVM["PopupViewModel"]:::presentation
            ProfileVM["ProfileViewModel"]:::presentation
        end

        subgraph "Repositories & Data Layer"
            direction TB
            AuthRepoInt["AuthRepository"]:::data
            PlantsRepoBase["PlantsRepositoryBase"]:::data
            ProfileRepoInt["ProfileRepository"]:::data
            AuthRepoFirebase["AuthRepositoryFirebase"]:::data
            PlantsRepoFirestore["PlantsRepositoryFirestore"]:::data
            ProfileRepoFirestore["ProfileRepositoryFirestore"]:::data
            PlantsRepoLocal["PlantsRepositoryLocal"]:::data
            PlantsRepoProvider["PlantsRepositoryProvider"]:::data
            ProfileRepoProvider["ProfileRepositoryProvider"]:::data
            LocalCache["Firestore Local Cache"]:::data
        end

        subgraph "Domain Models & Utils"
            direction TB
            PlantModel["Plant"]:::data
            ProfileModel["Profile"]:::data
            FirestoreMapper["FirestoreMapper"]:::data
            HealthCalc["PlantHealthCalculator"]:::data
            GoogleSignInHelper["GoogleSignInHelper"]:::data
        end
    end

    %% Device Resources
    subgraph "Device Resources"
        direction TB
        CameraSensor["Camera Sensor"]:::device
        NotificationMgr["Notification Manager"]:::device
    end

    %% Cloud Services
    subgraph "Cloud Services"
        direction TB
        FirebaseAuth["Firebase Authentication"]:::cloud
        GoogleOAuth["Google Sign-In OAuth"]:::cloud
        Firestore["Firebase Firestore"]:::cloud
        Storage["Firebase Storage"]:::cloud
        FCM["Firebase Cloud Messaging"]:::cloud
    end

    %% CI/CD
    subgraph "CI/CD & Testing"
        direction TB
        GitHubActions["GitHub Actions"]:::ci
        FirebaseEmulator["Firebase Emulator"]:::ci
    end

    %% Relationships
    MainActivity -->|hosts| NavHost
    MainActivity -->|launch| SignInScreen
    MainActivity -->|launch| CameraScreen
    MainActivity -->|launch| GardenScreen
    MainActivity -->|launch| EditPlantScreen
    MainActivity -->|launch| PlantInfoScreen
    MainActivity -->|launch| PopupScreen
    MainActivity -->|launch| ProfileScreens

    SignInScreen -->|uses| SignInVM
    CameraScreen -->|uses| CameraVM
    GardenScreen -->|uses| GardenVM
    EditPlantScreen -->|uses| EditPlantVM
    PlantInfoScreen -->|uses| PlantInfoVM
    PopupScreen -->|uses| PopupVM
    ProfileScreens -->|uses| ProfileVM

    SignInVM -->|calls| AuthRepoInt
    CameraVM -->|calls| PlantsRepoProvider
    CameraVM -->|calls| Firestore
    CameraVM -->|calls| Storage
    GardenVM -->|calls| PlantsRepoProvider
    EditPlantVM -->|calls| PlantsRepoProvider
    PlantInfoVM -->|calls| PlantsRepoProvider
    PopupVM -->|calls| PlantsRepoProvider
    ProfileVM -->|calls| ProfileRepoProvider

    AuthRepoInt -->|implemented by| AuthRepoFirebase
    PlantsRepoBase -->|implemented by| PlantsRepoFirestore
    ProfileRepoInt -->|implemented by| ProfileRepoFirestore
    PlantsRepoProvider -->|provides| PlantsRepoFirestore
    PlantsRepoProvider -->|provides| PlantsRepoLocal
    ProfileRepoProvider -->|provides| ProfileRepoFirestore

    AuthRepoFirebase -->|auth CRUD| FirebaseAuth
    PlantsRepoFirestore -->|data CRUD| Firestore
    ProfileRepoFirestore -->|data CRUD| Firestore
    PlantsRepoFirestore -->|cache sync| LocalCache
    PlantsRepoLocal -->|reads/writes| LocalCache

    Firestore -->|sync| LocalCache
    FCM -->|push| NotificationMgr
    NotificationMgr -->|schedule| NotificationMgr

    CameraSensor -->|capture photo| CameraScreen
    NotificationMgr -->|notify| MainActivity

    GoogleOAuth -->|authenticate| FirebaseAuth
    FirebaseAuth -->|tokens| AuthRepoFirebase

    GitHubActions -->|build & test| MainActivity
    GitHubActions -->|deploy| FirebaseEmulator

    %% Click Events
    click MainActivity "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/MainActivity.kt"
    click NavHost "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/navigation/AppNavHost.kt"
    click SignInScreen "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/authentication/SignInScreen.kt"
    click SignInVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/authentication/SignInViewModel.kt"
    click CameraScreen "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/camera/CameraScreen.kt"
    click CameraVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/camera/CameraViewModel.kt"
    click GardenScreen "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/garden/GardenScreen.kt"
    click GardenVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/garden/GardenViewModel.kt"
    click EditPlantScreen "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/editPlant/EditPlantScreen.kt"
    click EditPlantVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/editPlant/EditPlantViewModel.kt"
    click PlantInfoScreen "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/plantinfos/PlantInfoScreen.kt"
    click PlantInfoVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/plantinfos/PlantInfoViewModel.kt"
    click PopupScreen "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/popup/PopupScreen.kt"
    click PopupVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/popup/PopupViewModel.kt"
    click ProfileScreens "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/profile/ProfileScreenComposables.kt"
    click ProfileVM "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/profile/ProfileViewModel.kt"
    click UITheme "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/ui/theme/Theme.kt"
    click PlantModel "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/Plant.kt"
    click ProfileModel "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/profile/Profile.kt"
    click FirestoreMapper "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/FirestoreMapper.kt"
    click HealthCalc "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/PlantHealthCalculator.kt"
    click GoogleSignInHelper "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/authentication/GoogleSignInHelper.kt"
    click AuthRepoInt "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/authentication/AuthRepository.kt"
    click PlantsRepoBase "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/PlantsRepositoryBase.kt"
    click ProfileRepoInt "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/profile/ProfileRepository.kt"
    click AuthRepoFirebase "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/authentication/AuthRepositoryFirebase.kt"
    click PlantsRepoFirestore "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/PlantsRepositoryFirestore.kt"
    click ProfileRepoFirestore "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/profile/ProfileRepositoryFirestore.kt"
    click PlantsRepoLocal "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/PlantsRepositoryLocal.kt"
    click PlantsRepoProvider "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/plant/PlantsRepositoryProvider.kt"
    click ProfileRepoProvider "https://github.com/mygarden23/mygarden/blob/main/app/src/main/java/com/android/mygarden/model/profile/ProfileRepositoryProvider.kt"
    click GitHubActions "https://github.com/mygarden23/mygarden/blob/main/.github/workflows/build-apk.yml"
    click GitHubActions "https://github.com/mygarden23/mygarden/blob/main/.github/workflows/ci.yml"

    %% Styles
    classDef presentation fill:#D6EAF8,stroke:#1B4F72,stroke-width:1px
    classDef data fill:#D5F5E3,stroke:#145A32,stroke-width:1px
    classDef cloud fill:#FAD7A0,stroke:#7D6608,stroke-width:1px
    classDef device fill:#E8DAEF,stroke:#6C3483,stroke-width:1px
    classDef ci fill:#F2F4F4,stroke:#566573,stroke-width:1px
```
