# sricharan97/littlelemoneats architecture

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

- Interactive diagram: https://gitdiagram.com/sricharan97/littlelemoneats
- Repository: https://github.com/sricharan97/littlelemoneats

## Overview

##### Project Type and Purpose
- This is a native Android mobile application built with Kotlin and Jetpack Compose.
- Its purpose is to provide a seamless food ordering experience, including dynamic menu browsing, advanced filtering, search functionality, and secure transaction management for Little Lemon Restaurant.
- The project is structured as a typical Android application with a clean separation between UI, data management, and networking.

##### Main Architectural Components
a. UI Layer:
- Represents the user-facing part of the application, built entirely using Jetpack Compose.
- Key packages include:
- ui/composables for reusable UI components (e.g., ActionButton, Header, ProfileAvatar).
- ui/home, ui/menu, ui/onboarding, ui/profile for different screens.
- ui/theme for theming details supporting Material Design 3.
- Navigation is implemented using Compose Navigation (with NavigationComposable, LemonDestinations, etc.) to manage transitions between screens.

b. Data and Persistence Layer:
- Managed in the data package and includes:
- Entity and DAO classes (MenuEntity, MenuItemDao) using Room for local data persistence.
- Repositories (MenuRepository and UserPreferencesRepository) that handle data operations.
- Data classes (CartItem, UserData, UserPreferences) that represent application models.
- SharedPreferences are used to store simple user preferences.

c. Networking Layer:
- Encompasses the network package:
- Contains service interfaces and implementations (MenuItemService, MenuItemServiceImpl) to manage remote API calls using the Ktor client.
- DTOs (DataTransferObjects) for handling JSON data, ensuring clear separation of network data representation.
- All network requests are designed to run asynchronously using Kotlin coroutines.

d. Application Core/Entry Point:
- MainActivity.kt serves as the central entry point to the application.
- Associated ViewModel (MainViewModel.kt) is used for state management and to bridge between the UI and the business logic.

##### Relationships and Interactions
- UI Components (via Compose) interact with the ViewModel to receive state updates and issue user actions.
- The ViewModel communicates with repositories, which abstract the data sources.
- Repositories decide whether to retrieve or store data in the local Room database or fetch fresh data via the Ktor-based network services.
- Glide is used within UI components to asynchronously load and cache images for the menu items.
- Navigation components (NavigationComposable and Navigation Graph) maintain the flow and lifecycle management between different screens.

##### Architectural Patterns and Design Principles
- Layered Architecture: Clear separation between UI, data management, and networking.
- MVVM (Model-View-ViewModel): The integration of MainActivity, MainViewModel, and the repositories demonstrates clean separation of concerns.
- Asynchronous Programming: Networking and data persistence operations are managed using Kotlin coroutines to avoid blocking UI threads.
- Modular Design: Code is organized into packages (ui, data, navigation, network, utils), making it easier to understand and maintain.

##### Elements
- Annotations: Optionally note key technologies (Glide, Jetpack Compose, Ktor, Room) and specific design principles (MVVM, asynchronous processing).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        UI_Composables["Reusable Composables"]:::ui
        HomeScreen["Home Screen"]:::ui
        MenuScreen["Menu Screen"]:::ui
        OnboardingScreen["Onboarding Screen"]:::ui
        ProfileScreen["Profile Screen"]:::ui
        Theming["Theming"]:::ui
        CheckoutScreen["Checkout Screen"]:::ui
    end

    %% Navigation Layer
    subgraph "Navigation"
        NavigationComponent["Navigation Component"]:::navigation
        LemonDestinations["Lemon Destinations"]:::navigation
    end

    %% Business Logic Layer
    subgraph "Business Logic"
        MainActivity["Main Activity"]:::business
        MainViewModel["Main ViewModel"]:::business
        MenuRepository["Menu Repository"]:::business
        UserPreferencesRepository["User Preferences Repository"]:::business
    end

    %% Data Persistence Layer
    subgraph "Data Persistence"
        MenuEntity["Menu Entity"]:::db
        MenuItemDao["MenuItem Dao"]:::db
        DataModels["Data Models"]:::db
        RoomDB["Room Database"]:::db
    end

    %% Networking Layer
    subgraph "Networking"
        MenuItemService["MenuItem Service"]:::network
        MenuItemServiceImpl["MenuItem Service Impl"]:::network
        DTOs["Data Transfer Objects"]:::network
    end

    %% Connections from UI Layer to Business Logic
    HomeScreen -->|"triggers"| MainViewModel
    MenuScreen -->|"triggers"| MainViewModel
    OnboardingScreen -->|"triggers"| MainViewModel
    ProfileScreen -->|"triggers"| MainViewModel
    CheckoutScreen -->|"triggers"| MainViewModel

    %% Connections from Navigation to Business Logic
    NavigationComponent -->|"navigate"| MainActivity
    LemonDestinations -->|"navigate"| MainActivity

    %% Business Logic internal connections
    MainActivity -->|"init"| MainViewModel
    MainViewModel -->|"fetch-menu"| MenuRepository
    MainViewModel -->|"update-preferences"| UserPreferencesRepository

    %% Data Persistence interactions
    MenuRepository -->|"uses"| MenuEntity
    MenuRepository -->|"uses"| MenuItemDao
    UserPreferencesRepository -->|"read/write"| DataModels
    MenuRepository -->|"query/update"| RoomDB

    %% Networking interactions
    MenuRepository -->|"remote-call"| MenuItemService
    MenuItemService -->|"impl"| MenuItemServiceImpl
    MenuItemServiceImpl -->|"parse-data"| DTOs

    %% Styles
    classDef ui fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef navigation fill:#FFA07A,stroke:#000,stroke-width:2px;
    classDef business fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef db fill:#FFFACD,stroke:#000,stroke-width:2px;
    classDef network fill:#FFB6C1,stroke:#000,stroke-width:2px;

    %% Click Events for UI Layer
    click UI_Composables "https://github.com/sricharan97/littlelemoneats/tree/main/app/src/main/java/com/littlelemon/littlelemonapp/ui/composables"
    click HomeScreen "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/ui/home/HomeScreen.kt"
    click MenuScreen "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/ui/menu/MenuItemScreen.kt"
    click OnboardingScreen "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/ui/onboarding/Onboarding.kt"
    click ProfileScreen "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/ui/profile/ProfileScreen.kt"
    click Theming "https://github.com/sricharan97/littlelemoneats/tree/main/app/src/main/java/com/littlelemon/littlelemonapp/ui/theme"
    click CheckoutScreen "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/checkout/CheckoutScreen.kt"

    %% Click Events for Navigation Layer
    click NavigationComponent "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/navigation/NavigationComposable.kt"
    click LemonDestinations "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/LemonDestinations.kt"

    %% Click Events for Business Logic Layer
    click MainActivity "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/MainActivity.kt"
    click MainViewModel "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/MainViewModel.kt"
    click MenuRepository "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/data/MenuRepository.kt"
    click UserPreferencesRepository "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/data/UserPreferencesRepository.kt"

    %% Click Events for Data Persistence Layer
    click MenuEntity "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/data/MenuEntity.kt"
    click MenuItemDao "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/data/MenuItemDao.kt"
    click DataModels "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/data/CartItem.kt"
    click RoomDB "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/data/MenuDatabase.kt"

    %% Click Events for Networking Layer
    click MenuItemService "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/network/MenuItemService.kt"
    click MenuItemServiceImpl "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/network/MenuItemServiceImpl.kt"
    click DTOs "https://github.com/sricharan97/littlelemoneats/blob/main/app/src/main/java/com/littlelemon/littlelemonapp/network/DataTransferObjects.kt"
```
