How robot156/winenote works
Project Type & Purpose
• This is a full-stack Android application (mobile client only) for capturing, storing, and viewing wine tasting notes.
• Key indicators: multiple Gradle modules (app, core/*, feature/*), AndroidManifest.xml in app and feature modules, Compose + Hilt + Room in README.
File Structure & Architectural Patterns
Top-level modules:
• app – Android application entry point, DI setup, initializers, Google services, Proguard rules.
• build-logic – custom Gradle convention/plugins for consistent module setup.
• core/ – layered “clean architecture” cores:
– core/data (data-layer: Room DB, DataStore, remote sources, repositories, DI modules)
– core/domain (domain-layer: use cases, repository interfaces, dispatchers)
– core/model (shared data models & navigation routes)
– core/ui (shared UI components, base ViewModel, state management utilities)
– core/designsystem (theming, reusable Compose components)
• feature/* – feature modules for each screen: splash, main, wine-list, wine-detail, wine-write, wine-bin, setting. Each contains its own navigation, UI, ViewModel.
Architectural pattern: Clean/Onion/Clean Architecture with Modularization. Android-Compose MVVM with Hilt DI.
Extract Additional Insights from README
• Uses Kotlin, Jetpack Compose + Navigation, Coroutines/Flow, Paging3, Room, AAC ViewModel, Hilt.
• README’s “Module Graph” shows high-level module dependencies.
Main Components & Interactions
a. Presentation Layer (UI)
– Feature Modules (Compose Screens + Navigation + ViewModels)
– Shared UI modules (core/ui, core/designsystem)
b. Domain Layer
– Use Case classes in core/domain/usecase/*
c. Data Layer
– Repositories in core/data implementing domain interfaces
– Local: Room DB (WineNoteDatabase, DAOs), DataStore (PreferenceStorage)
– Remote: Firebase or custom remote data source
d. Application Layer
– app module: WineNoteApplication initializes DI, Timber, Firebase
e. Build Logic
– Custom Gradle plugins in build-logic for consistent module conventions
f. External Services
– Firebase (Analytics, Crashlytics, Storage)
– (Optional) cloud backend if remote data sync exists
Interaction Flow (example “View Wine List”):
UI Screen → ViewModel
→ UseCase (GetWineRecords)
→ Repository
↙︎ ↘︎
Room DAO Remote Data Source
↘︎ ↙︎
WineRecord Entities
↘︎
Flow<PagingData>
↘︎
UI displays list
Important Architectural Patterns & Principles
• Clean-architecture separation of concerns.
• Dependency inversion via Hilt (DataModule, DomainModule, UI injection).
• Modularization isolating features and shared cores.
• MVVM + unidirectional data flow (Flow / State).
• Compose Navigation per feature.
Essential Elements
• Clear component labels.
• Arrowheads for flow direction.