How 920anish/bookfinder works
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)