# nhoxbypass/fastfoodfinder architecture

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

- Interactive diagram: https://gitdiagram.com/nhoxbypass/fastfoodfinder
- Repository: https://github.com/nhoxbypass/fastfoodfinder

## Overview

##### Project Type and Purpose
- Fastfood Finder is an Android mobile application (client-side) that locates nearby fast‐food and convenience stores for users.
- It uses an MVPC (Model‑View‑Presenter‑Contract) architecture, layered modularization via Gradle multi‑modules, and integrates remote APIs (Firebase Auth/Store, Google Maps Directions), local persistence (Realm DB + SharedPreferences), background tasks (WorkManager), and cross‐component communication (EventBus).

##### File Structure
- Top-level Gradle modules:
- app – Android application module (UI, presenters, services)
- core/… – six core libraries (analytics, common utilities, location, logger, network, notifications, worker abstractions)
- data/… – four data modules (database, datastore, model, stores)
- app/src/main/java/com/iceteaviet/fastfoodfinder:
- ui/… – Activities, Fragments organized by feature (login, main, profile, store info, routing, settings, etc.)
- service/… – SyncService, WorkManager workers, EventBus
- data/… – DataManager and domain repositories (user, store, prefs, routing)
- data/local/… – DAOs, data sources, entities
- data/remote/… – API helpers for Firebase and Google Maps routing
- location/… – ILocationManager abstractions + implementations
- utils/… – app‑wide helper classes + Rx schedulers
- app/src/mock and app/src/prod – flavor-specific injection + fake implementations for testing
- tests cover presenters, data managers, DAOs, API helpers

##### README Insights
- Confirms MVPC architecture, SOLID principles, and heavy use of JUnit/Mockito for unit tests.
- Key libraries: Retrofit (network), Glide (images), WorkManager, RxJava2, EventBus, Realm.

a. Main Components
1. UI Layer (Activities, Fragments + Views + Contracts)
2. Presenter Layer (Presenters implementing business logic, invoking DataManager)
3. Service Layer
- SyncService & SyncDatabaseWorker (WorkManager)
- EventBus (RobotBus)
4. Data Layer
– DataManager (AppDataManager implements DataManager)
– Domain Repositories (UserRepository, StoreRepository, RoutingRepository, PreferencesRepository)
– Local Sources: Realm DB DAOs & SharedPreferences Helper
– Remote Sources:
- FirebaseAuth, FirebaseUserApiHelper, FirebaseStoreApiHelper
- GoogleMapsRoutingApiHelper using Retrofit
5. Core Libraries
– core/network (Retrofit + OkHttp abstraction)
– core/location (ILocationManager)
– core/worker (ComputationWorker, IOWorker, SerialWorker)
– core/common, core/logger, core/notifications, core/analytics
6. External Services
– Firebase (Auth, Firestore/Database)
– Google Maps Directions API

b. Relationships & Interactions
- UI invokes Presenter methods; Presenter calls DataManager.
- DataManager orchestrates calls to LocalSource and RemoteSource, returns Observables via RxJava.
- On app start or user actions, LocationManager fetches GPS coordinates; Presenter triggers routing via RoutingRepository->GoogleMaps API.
- SyncService schedules periodic SyncDatabaseWorker to sync remote store/user data into local DB.
- EventBus carries search results or background events back to UI.

c. Architectural Patterns & Principles
- MVPC pattern separates Views, Presenters, and Contracts.
- Repository pattern for DataManager with clear local/remote splits.
- Dependency Injection (Injection.kt) differentiates prod vs. mock for testing.
- SOLID: single‐responsibility modules (core, data, app), Interface-based abstractions (ILocationManager, DataManager).

d. Key Technologies & Frameworks
- Retrofit2 (HTTP client)
- Realm (local DB) + SharedPreferences
- WorkManager & Worker abstractions (core/worker)
- RxJava2 & SchedulerProvider
- EventBus (greenrobot)
- Glide (image loading)

##### Detailed Capture of Architectural Elements
- Injection component providing dependencies to Presenter and DataManager.
- EventBus as a bi‐directional bus between Service & UI.
- WorkManager scheduler invoking SyncDatabaseWorker, feeding into DataManager local DB.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        LoginActivity["LoginActivity"]:::ui
        MainActivity["MainActivity"]:::ui
    end

    %% Presenter & Service Layer
    subgraph "Presenter & Service Layer"
        direction TB
        BasePresenter["BasePresenter"]:::service
        LoginPresenter["LoginPresenter"]:::service
        MainPresenter["MainPresenter"]:::service
        SyncService["SyncService"]:::service
        SyncDatabaseWorker["SyncDatabaseWorker"]:::service
        RobotBus["RobotBus"]:::service
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        DataManager["DataManager"]:::data
        AppDataManager["AppDataManager"]:::data

        subgraph "Domain Repositories"
            direction TB
            UserRepository["UserRepository"]:::data
            AppUserRepository["AppUserRepository"]:::data
            StoreRepository["StoreRepository"]:::data
            AppStoreRepository["AppStoreRepository"]:::data
            MapsRoutingRepository["MapsRoutingRepository"]:::data
            AppMapsRoutingRepository["AppMapsRoutingRepository"]:::data
            PreferencesRepository["PreferencesRepository"]:::data
            AppPreferencesRepository["AppPreferencesRepository"]:::data
        end

        subgraph "Local Sources"
            direction TB
            RealmDB["Realm DB"]:::data
            SharedPrefs["SharedPreferences"]:::data
        end

        subgraph "Remote Sources"
            direction TB
            FirebaseAuthHelper["FirebaseClientAuth"]:::data
            FirebaseUserApiHelper["FirebaseUserApiHelper"]:::data
            FirebaseStoreApiHelper["FirebaseStoreApiHelper"]:::data
            GoogleMapsRoutingApiHelper["GoogleMapsRoutingApiHelper"]:::data
            MapsRoutingApi["MapsRoutingApi"]:::data
        end
    end

    %% Core Libraries
    subgraph "Core Libraries"
        direction TB
        CoreNetwork["core/network"]:::core
        CoreLocation["core/location"]:::core
        CoreWorker["core/worker"]:::core
        CoreCommon["core/common"]:::core
        CoreLogger["core/logger"]:::core
        CoreNotif["core/notifications"]:::core
        CoreAnalytics["core/analytics"]:::core
    end

    %% External Services
    subgraph "External Services"
        direction TB
        Firebase["Firebase (Auth, Firestore)"]:::external
        GoogleMaps["Google Maps Directions API"]:::external
    end

    %% Connections
    LoginActivity -->|"uses"| LoginPresenter
    MainActivity -->|"uses"| MainPresenter
    BasePresenter -->|"<implements>"| LoginPresenter
    BasePresenter -->|"<implements>"| MainPresenter

    LoginPresenter -->|"calls"| DataManager
    MainPresenter -->|"calls"| DataManager
    SyncService -->|"schedules"| SyncDatabaseWorker
    SyncDatabaseWorker -->|"sync via"| DataManager
    SyncDatabaseWorker -->|"posts events on"| RobotBus
    RobotBus -->|"delivers events to"| LoginActivity
    RobotBus -->|"delivers events to"| MainActivity

    DataManager -->|"implemented by"| AppDataManager
    AppDataManager -->|"orchestrates"| UserRepository
    AppDataManager -->|"orchestrates"| StoreRepository
    AppDataManager -->|"orchestrates"| MapsRoutingRepository
    AppDataManager -->|"orchestrates"| PreferencesRepository

    UserRepository -->|"<implemented by>"| AppUserRepository
    StoreRepository -->|"<implemented by>"| AppStoreRepository
    MapsRoutingRepository -->|"<implemented by>"| AppMapsRoutingRepository
    PreferencesRepository -->|"<implemented by>"| AppPreferencesRepository

    AppUserRepository -->|"reads/writes"| RealmDB
    AppStoreRepository -->|"reads/writes"| RealmDB
    AppPreferencesRepository -->|"reads/writes"| SharedPrefs

    AppUserRepository -->|"calls"| FirebaseUserApiHelper
    AppStoreRepository -->|"calls"| FirebaseStoreApiHelper
    AppMapsRoutingRepository -->|"calls"| GoogleMapsRoutingApiHelper
    GoogleMapsRoutingApiHelper -->|"uses"| MapsRoutingApi
    FirebaseUserApiHelper -->|"auth via"| Firebase
    FirebaseStoreApiHelper -->|"db via"| Firebase
    GoogleMapsRoutingApiHelper -->|"requests"| GoogleMaps

    %% Cross-layer integrations
    CoreNetwork -->|"<utilized by>"| FirebaseUserApiHelper
    CoreNetwork -->|"<utilized by>"| FirebaseStoreApiHelper
    CoreNetwork -->|"<utilized by>"| GoogleMapsRoutingApiHelper
    CoreLocation -->|"<injected into>"| CoreWorker
    CoreWorker -->|"<used by>"| SyncDatabaseWorker
    CoreAnalytics -->|"<used by>"| AppDataManager
    CoreLogger -->|"<used by>"| AppDataManager
    CoreNotif -->|"<used by>"| SyncService

    %% Click Events
    click LoginActivity "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/login/LoginActivity.kt"
    click LoginPresenter "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/login/LoginPresenter.kt"
    click LoginContract "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/login/LoginContract.kt"
    click MainActivity "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/main/MainActivity.kt"
    click MainPresenter "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/main/MainPresenter.kt"
    click MainContract "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/main/MainContract.kt"
    click BasePresenter "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/ui/base/BasePresenter.kt"
    click SyncService "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/service/SyncService.kt"
    click SyncDatabaseWorker "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/service/workers/SyncDatabaseWorker.kt"
    click RobotBus "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/service/eventbus/core/RobotBus.kt"
    click DataManager "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/DataManager.kt"
    click AppDataManager "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/AppDataManager.kt"
    click UserRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/user/UserRepository.kt"
    click AppUserRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/user/AppUserRepository.kt"
    click StoreRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/store/StoreRepository.kt"
    click AppStoreRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/store/AppStoreRepository.kt"
    click MapsRoutingRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/routing/MapsRoutingRepository.kt"
    click AppMapsRoutingRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/routing/AppMapsRoutingRepository.kt"
    click PreferencesRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/prefs/PreferencesRepository.kt"
    click AppPreferencesRepository "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/domain/prefs/AppPreferencesRepository.kt"
    click FirebaseClientAuth "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/auth/FirebaseClientAuth.kt"
    click FirebaseUserApiHelper "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/remote/user/FirebaseUserApiHelper.kt"
    click FirebaseStoreApiHelper "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/remote/store/FirebaseStoreApiHelper.kt"
    click GoogleMapsRoutingApiHelper "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/remote/routing/GoogleMapsRoutingApiHelper.kt"
    click MapsRoutingApi "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/remote/routing/MapsRoutingApi.kt"
    click RealmDB "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/local/db/store/StoreDAO.kt"
    click SharedPrefs "https://github.com/nhoxbypass/fastfoodfinder/blob/develop/app/src/main/java/com/iceteaviet/fastfoodfinder/data/local/prefs/AppPreferencesHelper.kt"

    %% Styles
    classDef ui fill:#B3DDF2,stroke:#2F6690,color:#000
    classDef service fill:#C2F0C2,stroke:#2E7D32,color:#000
    classDef data fill:#FFD59E,stroke:#E65100,color:#000
    classDef core fill:#D0D0D0,stroke:#888,color:#000
    classDef external fill:#F8BBD0,stroke:#C2185B,color:#000
```
