# rousgidraph/foodycourseapp architecture

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

- Interactive diagram: https://gitdiagram.com/rousgidraph/foodycourseapp
- Repository: https://github.com/rousgidraph/foodycourseapp

## Overview

##### Project type and purpose
- This is a single-module Android application (“Foody Course App”) built in Kotlin, following MVVM + Repository + DI patterns.
- It fetches recipes from a remote API (Retrofit), caches them in a Room database, manages user preferences via DataStore, and displays data in Activities/Fragments with RecyclerView adapters and data binding.

##### File structure
- Top-level “app” module with typical Android Gradle setup.
- ui/ (Activities & Fragments)
- adapters/ & bindingAdapters/ (RecyclerView & data-binding glue)
- viewModels/ (MainViewModel, RecipesViewModel)
- data/
– network/ (Retrofit interface)
– database/ (Room Database, DAO, Entities, TypeConverters)
– Repository, LocalDataSource, RemoteDataSource, DataStoreRepository
- di/ (DatabaseModule, NetworkModule)
- util/ (NetworkListener, extension functions, constants, NetworkResult)
- Build scripts declare dependencies on Retrofit, Room, DataStore, Lifecycle, Navigation, Hilt or Dagger (if included), MotionLayout, Shimmer, etc.

##### README
- Confirms emphasis on Retrofit, local & remote data sources, Room DB, caching, Safe Args (Navigation Component), MotionLayout, dark mode theming.

##### Components
a. Main components
- UI Layer: MainActivity, DetailsActivity, Fragments (Overview, Recipes, Ingredients, Instructions, FoodJoke, Favourites, BottomSheet)
- ViewModel Layer: MainViewModel, RecipesViewModel
- Data Layer:
- Repository (Repository.kt)
- LocalDataSource (Room via RecipesDatabase, RecipesDao, Entities)
- RemoteDataSource (Retrofit FoodRecipesApi)
- DataStoreRepository (for user preferences or paging states)
- DI Layer: DatabaseModule, NetworkModule (provide singletons for DB, Retrofit, DataStore, Repository)
- External Services:
- Remote Recipe API (e.g., Spoonacular)
- Android DataStore (preferences)
- Utilities: NetworkListener (monitors connectivity), NetworkResult wrapper

b. Relationships & interactions
1. UI (Activity/Fragment) ──> observes ViewModel LiveData/Flow
2. ViewModel ──> invokes Repository methods
3. Repository
- If online, calls RemoteDataSource → Retrofit → Remote API → returns JSON → mapped to models → writes to DB via LocalDataSource → returns data
- If offline or for caching, reads from LocalDataSource → Room DB
- Uses DataStoreRepository to read/write user settings
4. DI Modules provide injected instances to ViewModels and DataSources
5. NetworkListener feeds connectivity status to ViewModels or Repository

c. Architectural patterns & design principles
- MVVM (separate UI and business logic)
- Repository pattern (abstracts data sources)
- Single Activity + multiple Fragments + Navigation Component (my_nav.xml + Safe Args)
- Dependency Injection (modules for DB & network)
- Clean separation of concerns (UI, domain, data)
- Caching strategy (remote → local DB)
- Reactive streams (LiveData or Kotlin Flow)

d. Key technologies & libraries
- Kotlin, AndroidX (AppCompat, Lifecycle, Navigation)
- Retrofit + Gson/Moshi
- Room + Room TypeConverters
- DataStore (Preferences)
- Dagger Hilt or Dagger 2 (if present)
- Coroutines / Flow
- MotionLayout, Shimmer
- RecyclerView, ViewBinding / DataBinding

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "UI Layer"
        MainActivity["MainActivity"]:::ui
        DetailsActivity["DetailsActivity"]:::ui
        subgraph "Fragments"
            OverviewFragment["OverviewFragment"]:::ui
            RecipesFragment["RecipesFragment"]:::ui
            IngredientsFragment["IngredientsFragment"]:::ui
            InstructionFragment["InstructionFragment"]:::ui
            FoodJokeFragment["FoodJokeFragment"]:::ui
            FavouriteRecipesFragment["FavouriteRecipesFragment"]:::ui
            RecipesBottomSheet["RecipesBottomSheet"]:::ui
        end
    end

    subgraph "ViewModel Layer"
        MainViewModel["MainViewModel"]:::vm
        RecipesViewModel["RecipesViewModel"]:::vm
    end

    subgraph "Data Layer"
        subgraph "Repository & DataSources"
            Repository["Repository"]:::data
            LocalDataSource["LocalDataSource"]:::data
            RemoteDataSource["RemoteDataSource"]:::data
            DataStoreRepository["DataStoreRepository"]:::data
        end
        subgraph "Room Database"
            RecipesDatabase["RecipesDatabase"]:::db
            RecipesDao["RecipesDao"]:::db
            RecipesTypeConverter["RecipesTypeConverter"]:::db
            Entities["Entities (Recipes, Favourites, FoodJoke)"]:::db
        end
        subgraph "Network"
            FoodRecipesApi["FoodRecipesApi"]:::api
        end
    end

    subgraph "DI Layer"
        DatabaseModule["DatabaseModule"]:::di
        NetworkModule["NetworkModule"]:::di
    end

    subgraph "Utilities"
        NetworkListener["NetworkListener"]:::util
        NetworkResult["NetworkResult"]:::util
        Constants["Constants"]:::util
        MyExtensionFunctions["MyExtensionFunctions"]:::util
        RecipesDiffUtil["RecipesDiffUtil"]:::util
    end

    subgraph "External Services"
        RemoteAPI["Remote Recipe API"]:::ext
        AndroidDataStore["Android DataStore"]:::ext
    end

    %% Connections
    MainActivity -->|observes| MainViewModel
    DetailsActivity -->|observes| RecipesViewModel
    OverviewFragment -->|observes| RecipesViewModel
    RecipesFragment -->|observes| RecipesViewModel
    IngredientsFragment -->|observes| RecipesViewModel
    InstructionFragment -->|observes| RecipesViewModel
    FoodJokeFragment -->|observes| RecipesViewModel
    FavouriteRecipesFragment -->|observes| RecipesViewModel
    RecipesBottomSheet -->|observes| RecipesViewModel

    MainViewModel -->|calls| Repository
    RecipesViewModel -->|calls| Repository

    Repository -->|fetch/cache| RemoteDataSource
    Repository -->|fetch/cache| LocalDataSource
    Repository -->|user prefs| DataStoreRepository

    RemoteDataSource -->|Retrofit call| FoodRecipesApi
    FoodRecipesApi -->|JSON| RemoteAPI

    LocalDataSource -->|queries| RecipesDatabase
    RecipesDatabase -->|uses| RecipesDao
    RecipesDatabase -->|uses| RecipesTypeConverter
    RecipesDatabase -->|stores| Entities

    DataStoreRepository -->|reads/writes| AndroidDataStore

    NetworkListener -.->|status| RecipesViewModel

    DatabaseModule -->|provides| RecipesDatabase
    DatabaseModule -->|provides| RecipesDao
    DatabaseModule -->|provides| LocalDataSource
    DatabaseModule -->|provides| DataStoreRepository

    NetworkModule -->|provides| FoodRecipesApi
    NetworkModule -->|provides| RemoteDataSource
    NetworkModule -->|provides| Repository

    %% Click Events
    click MainActivity "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/MainActivity.kt"
    click DetailsActivity "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/DetailsActivity.kt"
    click OverviewFragment "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/overview/OverviewFragement.kt"
    click RecipesFragment "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/recipes/RecipesFragment.kt"
    click IngredientsFragment "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/ingredients/IngredientsFragment.kt"
    click InstructionFragment "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/instructions/InstructionFragment.kt"
    click FoodJokeFragment "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/foodjoke/FoodJokeFragment.kt"
    click FavouriteRecipesFragment "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/favourites/FavouriteRecipesFragment.kt"
    click RecipesBottomSheet "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/ui/fragments/recipes/bottomSheet/RecipesBottomSheet.kt"
    click MainViewModel "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/viewModels/MainViewModel.kt"
    click RecipesViewModel "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/viewModels/RecipesViewModel.kt"
    click Repository "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/Repository.kt"
    click LocalDataSource "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/LocalDataSource.kt"
    click RemoteDataSource "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/RemoteDataSource.kt"
    click DataStoreRepository "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/DataStoreRepository.kt"
    click RecipesDatabase "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/database/RecipesDatabase.kt"
    click RecipesDao "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/database/RecipesDao.kt"
    click RecipesTypeConverter "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/database/RecipesTypeConverter.kt"
    click DatabaseModule "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/di/DatabaseModule.kt"
    click NetworkModule "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/di/NetworkModule.kt"
    click FoodRecipesApi "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/data/network/FoodRecipesApi.kt"
    click NetworkListener "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/util/NetworkListener.kt"
    click NetworkResult "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/util/NetworkResult.kt"
    click Constants "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/util/Constants.kt"
    click MyExtensionFunctions "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/util/MyExtensionFunctions.kt"
    click RecipesDiffUtil "https://github.com/rousgidraph/foodycourseapp/blob/main/app/src/main/java/art/muriuki/foodycourseapp/util/RecipesDiffUtil.kt"

    %% Styles
    classDef ui fill:#D0E6FF,stroke:#0366d6,stroke-width:1px
    classDef vm fill:#DFFFE0,stroke:#28a745,stroke-width:1px,stroke-dasharray: 5 2
    classDef data fill:#FFE6CC,stroke:#d97706,stroke-width:1px
    classDef db fill:#FFD8A8,stroke:#c2410c,stroke-width:1px
    classDef api fill:#E2E2E2,stroke:#6c757d,stroke-width:1px,stroke-dasharray: 3 3
    classDef di fill:#E9D5FF,stroke:#7e22ce,stroke-width:1px,stroke-dasharray: 4 2
    classDef util fill:#FFF7D6,stroke:#f59e0b,stroke-width:1px
    classDef ext fill:#F0F0F0,stroke:#495057,stroke-width:1px,stroke-dasharray: 2 4
```
