# depromeet/16th-team6-android architecture

> Architecture diagram of the GitHub repository depromeet/16th-team6-android, 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/depromeet/16th-team6-android
- Repository: https://github.com/depromeet/16th-team6-android

## Overview

##### Project type and purpose
- This is a client-side Android application implemented in Kotlin using Jetpack Compose.
- Purpose: provide last-bus arrival & departure notifications (앗차!), with features such as home-screen alarms, lock-screen alerts, real-time transit data, and map-based location search.

##### File structure
- Top-level “app” module contains:
- src/main/java/com/depromeet/team6/… with 4 major packages:
– data (datalocal, dataremote, mapper, repositoryimpl)
– domain (models, repository interfaces, usecases)
– presentation (UI mappers, models, utilities)
– ui (Compose screens, ViewModels, navigation, common components)
- di (Hilt modules for Network, Service, Repository)
- Android components: BackgroundService, BroadcastReceiver, FirebaseMessagingService, permission utils
- libs (TMap SDK AARs) and keystore for signing
- Configuration files: Gradle scripts, Proguard, DataStore rules, backup rules

##### README for additional insights
- Architecture: Clean Architecture + MVI (UI → Domain → Data, unidirectional data flow)
- Uses AAC (NavigationGraph, ViewModel, Flow), Hilt for DI, Retrofit/OkHttp, Firebase FCM, TMap SDK, Kakao Login, Amplitude analytics, BackgroundService, BroadcastReceiver, Proguard/R8
- Emphasizes Repository Pattern, Event / SideEffect / UiState

## Diagram (Mermaid)

```mermaid
graph TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        UI["Compose UI Screens & Components"]:::presentation
        NavHost["MainNavHost"]:::presentation
        HomeVM["HomeViewModel"]:::presentation
        MVI["UiEvent/UiState/UiSideEffect"]:::presentation
        Analytics["AmplitudeUtils"]:::presentation
    end

    %% Domain Layer
    subgraph "Domain Layer"
        direction TB
        UseCase["GetBusArrivalUseCase"]:::domain
        RepoInt["AlarmRepository"]:::domain
        Model["BusArrival"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        subgraph "Remote Data"
            direction TB
            RemoteDS["AlarmRemoteDataSource"]:::data
            Service["AlarmService"]:::data
            Interceptor["AuthInterceptor"]:::data
            Mapper["ResponseBusArrivalDtoMapper"]:::data
        end
        subgraph "Local Data"
            direction TB
            FcmSvc["FcmService"]:::data
            LockSvc["LockService"]:::data
            NotifBuilder["SimpleNotificationBuilder"]:::data
            Permission["PermissionUtil"]:::data
        end
        RepoImpl["AlarmRepositoryImpl"]:::data
    end

    %% Hilt DI Modules
    subgraph "DI Modules"
        direction TB
        NetMod["NetworkModule"]:::data
        RepoMod["RepositoryModule"]:::data
        ServMod["ServiceModule"]:::data
    end

    %% Android Components
    subgraph "Android Components"
        direction TB
        BGService["BackgroundService"]:::data
        Receiver["NotificationReceiver"]:::data
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        API["REST API Server (Auth, Transit, TaxiCost, Locations)"]:::external
        FCM["Firebase Cloud Messaging"]:::external
        TMAP["TMap SDK"]:::external
        KAKAO["Kakao Login Service"]:::external
        AMP["Amplitude Analytics"]:::external
    end

    %% Relationships
    UI -->|"navigates via"| NavHost
    UI -->|"sends UiEvent"| HomeVM
    HomeVM -->|"uses"| MVI
    HomeVM -->|"invokes"| UseCase
    UseCase -->|"defined by"| RepoInt
    RepoImpl -->|"implements"| RepoInt
    RepoImpl -->|"calls"| RemoteDS
    RepoImpl -->|"calls"| FcmSvc
    RemoteDS -->|"retrofit call"| Service
    Service -->|"http request"| API
    Service -->|"auth via"| Interceptor
    RemoteDS -->|"maps response"| Mapper
    Mapper -->|"to Domain Model"| Model
    FcmSvc -->|"push event"| HomeVM
    LockSvc -->|"schedules notification"| NotifBuilder
    NotifBuilder -->|"uses"| Permission
    NavHost -->|"analytics"| Analytics
    Analytics -->|"sends event to"| AMP

    NetMod -->|"provides retrofit & interceptor"| Service
    RepoMod -->|"binds"| RepoInt & RepoImpl
    ServMod -->|"provides"| FcmSvc & LockSvc & BGService

    BGService -->|"sends alarm"| HomeVM
    Receiver -->|"broadcast"| HomeVM
    API -.->|"json"| Mapper

    TMAP -->|"map & geocode"| UI
    KAKAO -->|"auth login"| UI
    FCM -->|"push"| FcmSvc

    %% Click Events
    click UI "https://github.com/depromeet/16th-team6-android/tree/develop/app/src/main/java/com/depromeet/team6/presentation/ui"
    click NavHost "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/presentation/ui/main/navigation/MainNavHost.kt"
    click HomeVM "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/presentation/ui/home/HomeViewModel.kt"
    click MVI "https://github.com/depromeet/16th-team6-android/tree/develop/app/src/main/java/com/depromeet/team6/presentation/util/base"
    click Analytics "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/presentation/util/amplitude/AmplitudeUtils.kt"
    click UseCase "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/domain/usecase/GetBusArrivalUseCase.kt"
    click RepoInt "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/domain/repository/AlarmRepository.kt"
    click Model "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/domain/model/BusArrival.kt"
    click RemoteDS "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/dataremote/datasource/AlarmRemoteDataSource.kt"
    click Service "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/dataremote/service/AlarmService.kt"
    click Interceptor "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/dataremote/interceptor/AuthInterceptor.kt"
    click Mapper "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/mapper/todomain/ResponseBusArrivalDtoMapper.kt"
    click RepoImpl "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/repositoryimpl/AlarmRepositoryImpl.kt"
    click FcmSvc "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/datalocal/service/FcmService.kt"
    click LockSvc "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/datalocal/service/LockService.kt"
    click NotifBuilder "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/datalocal/builder/SimpleNotificationBuilder.kt"
    click Permission "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/data/datalocal/permission/PermissionUtil.kt"
    click NetMod "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/di/NetworkModule.kt"
    click RepoMod "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/di/RepositoryModule.kt"
    click ServMod "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/di/ServiceModule.kt"
    click Receiver "https://github.com/depromeet/16th-team6-android/blob/develop/app/src/main/java/com/depromeet/team6/presentation/ui/alarm/NotificationReceiver.kt"

    %% Styles
    classDef presentation fill:#bbdefb,stroke:#0d47a1,color:#0d47a1,stroke-width:2px
    classDef domain fill:#c8e6c9,stroke:#1b5e20,color:#1b5e20,stroke-width:2px
    classDef data fill:#ffe0b2,stroke:#e65100,color:#e65100,stroke-width:2px
    classDef external fill:#e0e0e0,stroke:#424242,color:#424242,stroke-width:2px
```
