How team-peekabook/peekabook-aos works
Project type and purpose
• This is an Android mobile client (“Peekabook”) built in Kotlin, applying a Clean-Architecture/MVVM pattern to let users view friends’ bookshelves, register and modify books, search by barcode or text, recommend books, and manage profiles/notifications.
File-structure analysis
• Top-level “app” module is the Android application.
• Under “app/src/main/java/com/sopt/peekabookaos” you see four main packages:
• data (entity/request/response, repository impls, Retrofit services, local/remote data sources)
• domain (business-level entities, repository interfaces, use-case classes)
• presentation (Activities, Fragments, ViewModels arranged by feature)
• di (Hilt modules for Retrofit, SharedPrefs, repositories)
• util contains shared helpers (extensions, binding adapters, dialogs).
• Config files: Gradle build scripts, ProGuard rules, AndroidManifest, assets (Lottie), resources.
Architecture & tech from README
• MVVM + Clean Architecture layers
• Coroutines, Flow, LiveData
• Hilt for DI
• Retrofit2 for HTTP, Glide for image loading
• AAC DataBinding, Navigation component
• CameraX & ML Kit (barcode scanning)
• Third-party: SlidingUpPanel, Timber
• Presentation Layer: UI (Activities/Fragments) + ViewModels
• Domain Layer: UseCases + Entity models + Repository interfaces
• Data Layer:
• Repository implementations
• Data Sources (Remote via Retrofit, Local via SharedPreferences)
• Network Client (Retrofit instance)
• External/Framework:
• REST API services (AuthService, BookService, etc.)
• Third-party SDKs (Kakao Login, Naver API, ML Kit)
• Android Framework (UI toolkit, Lifecycle, CameraX)
b. Relationships & interactions:
• UI → ViewModel (DataBinding + LiveData/Flow)
• ViewModel → UseCase
• UseCase → Repository interface
• Repository interface → Impl → DataSource (choose remote or local)
• Remote DataSource → Retrofit Service → External HTTP API
• Local DataSource → SharedPreferences
• Hilt modules wire RetrofitClient, DataSources, Repos, UseCases, ViewModels
c. Architectural patterns:
• Clean Architecture layers (Presentation → Domain → Data)
• MVVM inside Presentation
• Dependency Injection (Hilt) for decoupling
• Repository & DataSource abstraction
• Kotlin + Coroutines/Flow
• Hilt modules (RetrofitModule, RepositoryModule, SharedPrefModule)
• Retrofit services (AuthService, BookService, NaverService…)
• CameraX + ML Kit (BarcodeAnalyzer)