# team-peekabook/peekabook-aos architecture

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

- Interactive diagram: https://gitdiagram.com/team-peekabook/peekabook-aos
- Repository: https://github.com/team-peekabook/peekabook-aos

## Overview

##### 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)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        PLayer["Presentation Layer"]:::frontend
        PS1["BarcodeScannerFragment"]:::frontend
        PS2["BarcodeViewModel"]:::frontend
        PS3["BarcodeAnalyzer"]:::frontend
        PS4["Other UI/ViewModels"]:::frontend
    end

    %% Domain Layer
    subgraph "Domain Layer"
        DL1["Entity Models"]:::domain
        DL2["Repository Interfaces"]:::domain
        DL3["Use Cases"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        DT1["Repository Implementations"]:::data
        DT2["Remote Data Sources"]:::data
        DT3["Local Data Sources"]:::data
        DT4["Retrofit Service Interfaces"]:::data
        DT5["Data Entities & DTOs"]:::data
    end

    %% Dependency Injection Modules
    subgraph "DI Modules"
        DI1["RetrofitModule"]:::data
        DI2["RetrofitServiceModule"]:::data
        DI3["RepositoryModule"]:::data
        DI4["SharedPrefModule"]:::data
        DI5["NaverRetrofitModule"]:::data
        DI6["RefreshRetrofitModule"]:::data
    end

    %% Infrastructure
    LS[(SharedPreferences)]:::data
    NC["Retrofit Client"]:::external

    %% External Services/Frameworks
    EX3["KakaoLoginService API"]:::external
    EX1["AuthService API"]:::external
    EX2["BookService API"]:::external
    EX4["NaverService API"]:::external
    EX5["Push Notifications"]:::external
    PMSG["PeekaMessageService"]:::external
    EX6["CameraX & ML Kit"]:::external

    %% Connections
    PS1 -->|"binds to"| PS2
    PS2 -->|"calls"| DL3
    DL3 -->|"depends on"| DL2
    DL2 -->|"implemented by"| DT1
    DT1 -->|"uses"| DT2
    DT1 -->|"uses"| DT3
    DT2 -->|"calls"| DT4
    DT4 -->|"via"| NC
    DT3 -->|"stores in"| LS
    NC -->|"http calls"| EX1
    NC -->|"http calls"| EX2
    NC -->|"http calls"| EX3
    NC -->|"http calls"| EX4
    LS -->|"local storage"| DT3
    PS3 -->|"analyzes"| EX6
    PMSG -->|"push handling"| EX5

    %% DI wiring
    DI1 --> NC
    DI2 --> DT4
    DI3 --> DT1
    DI3 --> DL3
    DI4 --> LS
    DI5 --> NC
    DI6 --> NC

    %% Click Events
    click PLayer "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/presentation"
    click PS1 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/presentation/barcodeScanner/BarcodeScannerFragment.kt"
    click PS2 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/presentation/barcodeScanner/BarcodeViewModel.kt"
    click PS3 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/presentation/barcodeScanner/BarcodeAnalyzer.kt"
    click DL1 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/domain/entity"
    click DL2 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/domain/repository"
    click DL3 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/domain/usecase"
    click DT1 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/data/repository"
    click DT2 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/data/source/remote"
    click DT3 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/data/source/local"
    click DT4 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/data/service"
    click DT5 "https://github.com/team-peekabook/peekabook-aos/tree/develop/app/src/main/java/com/sopt/peekabookaos/data/entity"
    click DI1 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/RetrofitModule.kt"
    click DI2 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/RetrofitServiceModule.kt"
    click DI3 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/RepositoryModule.kt"
    click DI4 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/SharedPrefModule.kt"
    click DI5 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/NaverRetrofitModule.kt"
    click DI6 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/RefreshRetrofitModule.kt"
    click LS "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/data/source/local/LocalPrefDataSource.kt"
    click NC "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/di/RetrofitModule.kt"
    click EX3 "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/data/service/KakaoLoginService.kt"
    click PMSG "https://github.com/team-peekabook/peekabook-aos/blob/develop/app/src/main/java/com/sopt/peekabookaos/PeekaMessageService.kt"

    %% Styles
    classDef frontend fill:#D0E9FF,stroke:#333,stroke-width:1px
    classDef domain fill:#D3FFD0,stroke:#333,stroke-width:1px
    classDef data fill:#FFE5B4,stroke:#333,stroke-width:1px
    classDef external fill:#E0E0E0,stroke:#333,stroke-width:1px
```
