# 920anish/bookfinder architecture

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

- Interactive diagram: https://gitdiagram.com/920anish/bookfinder
- Repository: https://github.com/920anish/bookfinder

## Overview

##### Project Type and Purpose
- This is an Android mobile application (“BookFinderApp”) built with Jetpack Compose, following MVVM architecture.
- It fetches book data from an external REST API, displays lists and details, and lets users save favorites locally (Room) with offline support.

##### Top‐Level File Structure Analysis
- app/src/main/java/com/internsathi/bookfinder
– BookFinderApp.kt (Hilt application class)
– MainActivity.kt (Compose host + Navigation setup)
- data/local
– Room DAO, Database and Repositories for favorite books
– DataStore (UserPreferenceRepository) for theme/settings
- data/network
– Retrofit API service (BooksApiService) + network repository
- di
– Hilt AppModule for providing singletons (Retrofit, DB, DAOs, Repos)
- model, navigation, ui/screens, ui/theme, ui/utils, viewmodel

##### Key Architectural Patterns
- MVVM: View layer (Compose UI + Navigation) ←→ ViewModel ←→ Repository
- Dependency Injection (Hilt): decouples creation of Retrofit, Room, DataStore, Repos, ViewModels.
- Clean separation:
- Presentation (UI + Navigation)
- Domain/State (ViewModel, Models)
- Data (Network + Local Data Sources)

##### Main Components
a. Presentation Layer
- Android Device / App Shell (MainActivity, BookFinderApp)
- Navigation Component (Navigation.kt, Routes.kt)
- Compose UI Screens (HomeScreen, BookScreen, DetailScreen, FavouriteScreen, etc.)
b. ViewModels
- BooksViewModel – orchestrates data requests, holds UI state (BooksState)
c. Repository Layer
- BooksRepository (Retrofit service)
- FavouriteBooksRepository / OfflineFavouriteBooksRepository (Room DB)
- UserPreferenceRepository (DataStore)
d. Data Sources & Infrastructure
- External REST API (BooksApiService over Retrofit)
- Room Database (FavouriteBooksDatabase + FavouriteBookDao)
- DataStore Preferences
e. Dependency Injection
- Hilt AppModule providing all above components
f. External Services
- Third‑party Book API
- Coil image‑loading (used in UI, can be a utility dependency)

##### Interactions and Data Flows
- User taps UI → Navigation triggers new Screen composable → Screen calls ViewModel methods
- ViewModel requests data → injected Repository
- Network path: Repository → Retrofit service → parse response → emit to ViewModel
- Local path: Repository → Room DAO or DataStore → emit to ViewModel
- ViewModel updates compose state → UI re‑composes
- Favorite action → ViewModel → local repository → Room write
- Offline mode: ViewModel → OfflineFavouriteBooksRepository → Room read

##### Diagramming Conventions
- Use rectangles for software modules (e.g., ViewModel, Repos)

## Diagram (Mermaid)

```mermaid
flowchart TB
  %% Presentation Layer
  subgraph "Presentation Layer"
    direction TB
    App["BookFinderApp"]:::presentation
    MainActivity["MainActivity"]:::presentation
    Navigation["Navigation"]:::presentation
    Routes["Routes"]:::presentation
    HomeScreen["HomeScreen"]:::presentation
    BookScreen["BookScreen"]:::presentation
    DetailScreen["DetailScreen"]:::presentation
    FavouriteScreen["FavouriteScreen"]:::presentation
    FavouriteDetailScreen["FavouriteDetailScreen"]:::presentation
    ErrorScreen["ErrorScreen"]:::presentation
    BottomNavBar["BottomNavBar"]:::presentation
    BottomNavItem["BottomNavItem"]:::presentation
    ColorTheme["Color, Type, Theme"]:::presentation
  end

  %% ViewModel Layer
  subgraph "ViewModel Layer"
    direction TB
    BooksViewModel["BooksViewModel"]:::viewmodel
  end

  %% Repository Layer
  subgraph "Repository Layer"
    direction TB
    BooksRepository["BooksRepository"]:::repository
    FavouriteBooksRepository["FavouriteBooksRepository"]:::repository
    OfflineFavouriteBooksRepository["OfflineFavouriteBooksRepository"]:::repository
    UserPreferenceRepository["UserPreferenceRepository"]:::repository
  end

  %% DI Container
  subgraph "DI Container"
    direction TB
    AppModule["AppModule"]:::di
  end

  %% Infrastructure Layer
  subgraph "Infrastructure Layer"
    direction TB
    BooksApiService["BooksApiService"]:::infra
    FavouriteBookDao["FavouriteBookDao"]:::infra
    FavouriteBooksDatabase["FavouriteBooksDatabase"]:::infra
    DataStore["DataStore"]:::infra
  end

  %% External Services
  subgraph "External Services"
    direction TB
    ExternalAPI["External Book API"]:::external
    Coil["Coil Image Loader"]:::external
  end

  %% Connections Presentation -> ViewModel
  App -->|"launch"| MainActivity
  MainActivity -->|"compose host"| Navigation
  Navigation -->|"route"| HomeScreen
  Navigation -->|"route"| BookScreen
  Navigation -->|"route"| DetailScreen
  Navigation -->|"route"| FavouriteScreen
  Navigation -->|"route"| FavouriteDetailScreen
  Navigation -->|"route"| ErrorScreen
  HomeScreen -->|"interact"| BooksViewModel
  BookScreen -->|"interact"| BooksViewModel
  DetailScreen -->|"interact"| BooksViewModel
  FavouriteScreen -->|"interact"| BooksViewModel
  FavouriteDetailScreen -->|"interact"| BooksViewModel
  ErrorScreen -->|"interact"| BooksViewModel
  HomeScreen -->|"uses"| BottomNavBar
  BottomNavBar -->|"items"| BottomNavItem
  HomeScreen -->|"style"| ColorTheme
  BookScreen -->|"style"| ColorTheme
  DetailScreen -->|"style"| ColorTheme
  FavouriteScreen -->|"style"| ColorTheme
  ErrorScreen -->|"style"| ColorTheme
  HomeScreen -->|"load image"| Coil
  BookScreen -->|"load image"| Coil
  DetailScreen -->|"load image"| Coil
  FavouriteScreen -->|"load image"| Coil
  FavouriteDetailScreen -->|"load image"| Coil

  %% ViewModel -> Repositories
  BooksViewModel -->|"fetchBooks()"| BooksRepository
  BooksViewModel -->|"getFavorites()"| FavouriteBooksRepository
  BooksViewModel -->|"getOfflineFavorites()"| OfflineFavouriteBooksRepository
  BooksViewModel -->|"savePreference()"| UserPreferenceRepository

  %% Repositories -> Infrastructure
  BooksRepository -->|"api call"| BooksApiService
  FavouriteBooksRepository -->|"db write/read"| FavouriteBookDao
  OfflineFavouriteBooksRepository -->|"db read"| FavouriteBookDao
  UserPreferenceRepository -->|"prefs read/write"| DataStore

  %% Infrastructure -> External/Storage
  BooksApiService -->|"HTTP"| ExternalAPI
  FavouriteBookDao -->|"persist"| FavouriteBooksDatabase
  DataStore -->|"persist"| DataStore

  %% DI Container provides
  AppModule --> BooksViewModel
  AppModule --> BooksRepository
  AppModule --> BooksApiService
  AppModule --> FavouriteBooksRepository
  AppModule --> OfflineFavouriteBooksRepository
  AppModule --> UserPreferenceRepository
  AppModule --> FavouriteBookDao
  AppModule --> FavouriteBooksDatabase
  AppModule --> DataStore

  %% Click Events
  click App "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/BookFinderApp.kt"
  click MainActivity "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/MainActivity.kt"
  click Navigation "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/navigation/Navigation.kt"
  click Routes "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/navigation/Routes.kt"
  click HomeScreen "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/screens/HomeScreen.kt"
  click BookScreen "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/screens/BookScreen.kt"
  click DetailScreen "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/screens/DetailScreen.kt"
  click FavouriteScreen "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/screens/FavouriteScreen.kt"
  click FavouriteDetailScreen "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/screens/FavouriteDetailScreen.kt"
  click ErrorScreen "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/screens/ErrorScreen.kt"
  click BottomNavBar "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/utils/BottomNavBar.kt"
  click BottomNavItem "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/utils/BottomNavItem.kt"
  click ColorTheme "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/theme/Color.kt"
  click ColorTheme "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/theme/Type.kt"
  click ColorTheme "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/ui/theme/Theme.kt"
  click BooksViewModel "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/viewmodel/BooksViewModel.kt"
  click BooksRepository "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/network/BooksRepository.kt"
  click BooksApiService "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/network/BooksApiService.kt"
  click FavouriteBooksRepository "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/local/FavouriteBooksRepository.kt"
  click OfflineFavouriteBooksRepository "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/local/OfflineFavouriteBooksRepository.kt"
  click UserPreferenceRepository "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/local/UserPreferenceRepository.kt"
  click FavouriteBookDao "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/local/FavouriteBookDao.kt"
  click FavouriteBooksDatabase "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/data/local/FavouriteBooksDatabase.kt"
  click AppModule "https://github.com/920anish/bookfinder/blob/master/app/src/main/java/com/internsathi/bookfinder/di/AppModule.kt"

  %% Styles
  classDef presentation fill:#ADD8E6,stroke:#000,stroke-width:1px
  classDef viewmodel fill:#90EE90,stroke:#000,stroke-width:1px
  classDef repository fill:#98FB98,stroke:#000,stroke-width:1px
  classDef infra fill:#FFD700,stroke:#000,stroke-width:1px
  classDef external fill:#D3D3D3,stroke:#000,stroke-width:1px
  classDef di fill:#FFB6C1,stroke:#000,stroke-width:1px
```
