# piashcse/hilt-mvvm-compose-movie architecture

> Architecture diagram of the GitHub repository piashcse/hilt-mvvm-compose-movie, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/piashcse/hilt-mvvm-compose-movie
- Repository: https://github.com/piashcse/hilt-mvvm-compose-movie

## Overview

##### Project type and purpose
- A native Android application (min SDK 23+)
- Implements MVVM with Repository pattern, local Room DB, remote TMDB API, Paging 3
- Purpose: Browse/search movies, TV-series, celebrities, manage favorites

##### File structure
- app/src/main/java/com/piashcse/hilt_mvvm_compose_movie
– di: Hilt modules (NetworkModule, DataBaseModule, RepositoryModule)
– data: datasources (local & remote), models, repositories (local & remote)
– network: API interceptor, constants
– ui: Composable components, screens, navigation, themes, state
– utils: constants, extensions, network‐connection helpers
– HiltApplication.kt: Application class for DI
- app/src/main/res: UI resources
- build scripts: Gradle Kotlin DSL, CI/CD workflow

##### Extract README insights
- Patterns: MVVM (Model–ViewModel–View), Repository
- Tech stack: Kotlin, Compose, Hilt, Coroutines, Flow, Room, Retrofit, Paging3
- External service: The Movie DB API (requires API key)

##### Main components & interactions
A. UI Layer
– Composable Screens & Components (e.g. MovieList, MovieDetail, FavoriteMovie)
– Navigation Graph (NavGraph)
B. ViewModel Layer
– One ViewModel per screen (e.g. MainViewModel, MovieDetailViewModel)
– Exposes State (Flow/LiveData) to UI
C. Domain/Data Layer
– Repositories
- RemoteRepositoryImpl (Retrofit ApiService + PagingDataSource)
- LocalRepositoryImpl (Room DAOs)
– DataSources
- ApiService (Retrofit interface)
- MovieWorldDataBase (Room database)
- DAOs: FavoriteMovieDao, FavoriteTvSeriesDao
D. External Systems
– TMDB REST API (HTTPS calls via Retrofit + OkHttp + ApiKeyInterceptor)
E. Dependency Injection
– Hilt Modules provide singletons: Retrofit, OkHttpClient, Database, Repositories

##### Relationships & data flow
1. UI → calls ViewModel functions (e.g. fetchPopularMovies())
2. ViewModel → invokes Repository interfaces
3. Repository → chooses DataSource
- Remote paths: Repository → ApiService → Remote PagingDataSource → Flow<PagingData>
- Local paths: Repository → Room DAO → Flow<List<Entity>>
4. Data flows back up as Flow/LiveData → ViewModel → UI consumes & renders
5. Hilt: at application startup, modules wire up Retrofit, DB, Repos, ViewModels

##### Architectural patterns & principles
- MVVM: separation of concerns (UI vs state vs data logic)
- Repository pattern: abstracts data sources (local vs remote) behind a common interface
- Paging3: for infinite scroll lists
- Single Responsibility & DI: each module/class has one role, dependencies injected via Hilt

##### Essential elements
– HiltApplication (app entry)
– NetworkModule → provides Retrofit + ApiKeyInterceptor
– DataBaseModule → provides Room database + DAOs
– RepositoryModule → binds interfaces to implementations
– ApiService & PagingDataSources (e.g. PopularMoviePagingDataSource)
– Room DAOs & MovieWorldDataBase
– ViewModels for main screens
– Composable NavGraph & sample Screen
– The Movie DB API as external system

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Hilt Application Entry
    HA["HiltApplication"]:::di
    click HA "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/HiltApplication.kt"

    %% Dependency Injection Modules
    subgraph "Dependency Injection" 
        direction TB
        NM["NetworkModule"]:::di
        click NM "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/di/NetworkModule.kt"
        DBM["DataBaseModule"]:::di
        click DBM "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/di/DataBaseModule.kt"
        RM["RepositoryModule"]:::di
        click RM "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/di/RepositoryModule.kt"
    end

    HA --> NM
    HA --> DBM
    HA --> RM

    %% Infrastructure Layer
    subgraph "Infrastructure" 
        direction TB
        IK["ApiKeyInterceptor"]:::infra
        click IK "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/network/ApiKeyInterceptor.kt"
        AS["ApiService (Retrofit)"]:::infra
        click AS "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/remote/ApiService.kt"
        AU["ApiURL Constants"]:::infra
        click AU "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/remote/ApiURL.kt"
        DB["MovieWorldDataBase"]:::infra
        click DB "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/local/MovieWorldDataBase.kt"
        DM["FavoriteMovieDao"]:::infra
        click DM "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/local/dao/FavoriteMovieDao.kt"
        DT["FavoriteTvSeriesDao"]:::infra
        click DT "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/local/dao/FavoriteTvSeriesDao.kt"
    end

    NM --> IK
    NM --> AS
    NM --> AU
    DBM --> DB
    DBM --> DM
    DBM --> DT

    %% Data Layer (Repositories & DataSources)
    subgraph "Domain/Data Layer" 
        direction TB
        subgraph "Remote Repositories" 
            direction TB
            MRi["MovieRepositoryImpl"]:::data
            MRi --> AS
            TRi["TvSeriesRepositoryImpl"]:::data
            CRi["CelebrityRepositoryImpl"]:::data
            ARi["ArtistRepositoryImpl"]:::data
        end
        subgraph "Local Repositories" 
            direction TB
            LMRi["LocalMovieRepositoryImpl"]:::data
            LTRi["LocalTvSeriesRepositoryImpl"]:::data
            LMRi --> DM
            LTRi --> DT
        end
        subgraph "Paging DataSources" 
            direction TB
            PMP["PopularMoviePagingDataSource"]:::data
            click PMP "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/remote/paging_datasource/movie/PopularMoviePagingDataSource.kt"
            NMP["NowPlayingMoviePagingDataSource"]:::data
            click NMP "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/remote/paging_datasource/movie/NowPlayingMoviePagingDataSource.kt"
            PTP["PopularTvSeriesPagingDataSource"]:::data
            click PTP "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/remote/paging_datasource/tv_series/PopularTvSeriesPagingDataSource.kt"
            PCP["PopularCelebritiesPagingDataSource"]:::data
            click PCP "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/data/datasource/remote/paging_datasource/celebrities/PopularCelebritiesPagingDataSource.kt"
        end
        %% Interfaces Binding
        MRi -->|implements| RM
        TRi -->|implements| RM
        CRi -->|implements| RM
        ARi -->|implements| RM
        LMRi -->|implements| RM
        LTRi -->|implements| RM
        RM --> MRi
        RM --> TRi
        RM --> CRi
        RM --> ARi
        RM --> LMRi
        RM --> LTRi
        %% Paging hooks
        MRi --> PMP
        MRi --> NMP
        TRi --> PTP
        CRi --> PCP
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer" 
        direction TB
        MV["MainViewModel"]:::viewmodel
        click MV "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/mainscreen/MainViewModel.kt"
        MDV["MovieDetailViewModel"]:::viewmodel
        click MDV "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/movies/movie_detail/MovieDetailViewModel.kt"
        FMV["FavoriteMovieViewModel"]:::viewmodel
        click FMV "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/favorite/movie/FavoriteMovieViewModel.kt"
        FTV["FavoriteTvSeriesViewModel"]:::viewmodel
        click FTV "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/favorite/tvseries/FavoriteTvSeriesViewModel.kt"
        MAV["MainActivityViewModel"]:::viewmodel
        click MAV "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/activity/MainActivityViewModel.kt"
    end

    %% UI Layer
    subgraph "UI Layer" 
        direction TB
        NAV["NavGraph"]:::ui
        click NAV "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/navigation/NavGraph.kt"
        MS["MainScreen"]:::ui
        click MS "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/mainscreen/MainScreen.kt"
        MD["MovieDetail"]:::ui
        click MD "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/movies/movie_detail/MovieDetail.kt"
        FM["FavoriteMovie"]:::ui
        click FM "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/favorite/movie/FavoriteMovie.kt"
        FT["FavoriteTvSeries"]:::ui
        click FT "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/favorite/tvseries/FavoriteTvSeries.kt"
        MA["MainActivity"]:::ui
        click MA "https://github.com/piashcse/hilt-mvvm-compose-movie/blob/master/app/src/main/java/com/piashcse/hilt_mvvm_compose_movie/ui/screens/activity/MainActivity.kt"
    end

    %% External API
    TMDB["TMDB REST API"]:::external

    %% Connections UI->ViewModel
    MA -->|uses| MAV
    NAV -->|navigates to| MS
    NAV -->|navigates to| MD
    NAV -->|navigates to| FM
    NAV -->|navigates to| FT
    MS -->|calls| MV
    MD -->|calls| MDV
    FM -->|calls| FMV
    FT -->|calls| FTV

    %% ViewModel->Repository
    MV -->|requests data| MRi
    MV -->|requests data| LMRi
    MDV --> MRi
    FMV --> LMRi
    FTV --> LTRi
    MAV --> MRi

    %% Data Flow back
    MRi -->|Flow<PagingData>| MV
    LMRi -->|Flow<List>| MV

    %% Repository->DataSource
    MRi --> AS
    LMRi --> DB

    %% Infra to External
    AS -->|HTTP| TMDB
    IK --> AS

    %% Styles
    classDef ui fill:#e0f7e9,stroke:#2e7d32;
    classDef viewmodel fill:#d0e1f9,stroke:#1565c0;
    classDef data fill:#fce8b2,stroke:#ef6c00;
    classDef infra fill:#e0e0e0,stroke:#424242;
    classDef di fill:#e6e0f8,stroke:#6a1b9a;
    classDef external fill:#f9d0d0,stroke:#b71c1c;
```
