# himanshi-gupta/movieshow architecture

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

- Interactive diagram: https://gitdiagram.com/himanshi-gupta/movieshow
- Repository: https://github.com/himanshi-gupta/movieshow

## Overview

##### Project type and purpose
- This is a native Android mobile application (MovieShow) written in Kotlin.
- Purpose: fetches movie data (popular, upcoming, trending, top-rated) from an external API, displays lists in tabs, supports detailed views, and maintains a local watchlist with offline support.

##### File structure
- Top level: build files (`build.gradle`, `settings.gradle`), Gradle wrapper.
- `app/`: main Android module.
- `src/main/java/com/example/movieshow/` contains:
– `ui/` & `ui/theme/`: presentation layer (Compose or XML-based UI + theming).
– `viewModels/`: ViewModel classes (MVVM).
– `repository/`: MovieRepo (handles data coordination).
– `network/`: MovieApi (Retrofit interface).
– `database/`: Room entities (`MovieItem`), Dao, `MovieDatabase`.
– `paging/`: `MoviePagingSource` (Jetpack Paging).
– `Observer/`: network connectivity observers.
– `models/`: data models mapping API responses.
– `factory/`: ViewModelFactory classes.
– `utils/`: constants for configuration.
- Test folders for unit and instrumentation tests.
- `AndroidManifest.xml`, `res/` for resources (drawables, layouts, strings, themes).
- Gradle/proguard rules, `.gitignore`.

##### Extract architecture from README
- Uses remote API calls to fetch multiple movie categories.
- Local persistence of watchlist via Room.
- Offline navigation to watchlist.
- Retry logic on network failures.

##### Relationships and data flow
- UI → ViewModel: UI events (tab selection, add/remove watchlist, retry).
- ViewModel → Repository: request data streams or write operations.
- Repository → Remote Data Source: fetch paged lists via Retrofit + PagingSource.
- Repository → Local Data Source: read/write watchlist entities.
- Repository → ViewModel: returns LiveData/Flow of data.
- ViewModel → UI: exposes UI state (paged lists, network status, watchlist).
- ConnectivityObserver broadcasts to ViewModel to react to offline/online changes.

##### Architectural patterns & technologies
- MVVM (Model-View-ViewModel).
- Repository as single data orchestrator.
- Room for local persistence.
- Retrofit + OkHttp for networking.
- Jetpack Paging for infinite scrolling.
- LiveData or Kotlin Flow for state propagation.
- Dependency injection via manual factories.

##### Detail
- Every folder in `src/main/java` is represented by a component or subcomponent.
- Watchlist flow: UI (Watchlist Screen) → ViewModel → Repo → Room → UI restoration on app launch.
- Offline navigation: ConnectivityObserver → ViewModel → Navigation to Watchlist.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        MainActivity["MainActivity"]:::ui
        UIComponents["UI Components (Compose/XML)"]:::ui
        UITheme["UI Theme Files"]:::ui
        Resources["Android Resources"]:::ui
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        direction TB
        MovieVM["MovieViewModel"]:::vm
        PopularVM["PopularViewModel"]:::vm
        TrendingVM["TrendingViewModel"]:::vm
        TopRatedVM["TopRatedViewModel"]:::vm
        UpcomingVM["UpcomingViewModel"]:::vm
    end

    %% Repository Layer
    subgraph "Repository Layer"
        direction TB
        MovieRepo["MovieRepo"]:::repo
    end

    %% Remote Data Source
    subgraph "Remote Data Source"
        direction TB
        MovieApi["MovieApi (Retrofit)"]:::network
        PagingSource["MoviePagingSource"]:::network
    end

    %% Local Data Source
    subgraph "Local Data Source"
        direction TB
        MovieDB["MovieDatabase"]:::db
        MovieDao["MovieDao"]:::db
        MovieItem["MovieItem Entity"]:::db
    end

    %% Connectivity Observer
    subgraph "Connectivity Observer"
        direction TB
        ConnectivityObs["ConnectivityObserver"]:::obs
        NetworkConnectivityObs["NetworkConnectivityObserver"]:::obs
    end

    %% Models
    subgraph "Model Definitions"
        direction TB
        MovieModel["Movie.kt"]:::model
        ResponseModel["Response.kt"]:::model
    end

    %% Factories
    subgraph "ViewModel Factories"
        direction TB
        MovieVMFactory["MovieViewModelFactory"]:::factory
        PopularVMFactory["PopularViewModelFactory"]:::factory
        TrendingVMFactory["TrendingViewModelFactory"]:::factory
        TopRatedVMFactory["TopRatedViewModelFactory"]:::factory
        UpcomingVMFactory["UpcomingViewModeFactory"]:::factory
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        Constants["Constants"]:::util
    end

    %% External System
    ExternalAPI["External Movie API"]:::external

    %% Connections: UI to ViewModel
    MainActivity -->|"UI events"| MovieVM
    MainActivity -->|"UI events"| PopularVM
    MainActivity -->|"UI events"| TrendingVM
    MainActivity -->|"UI events"| TopRatedVM
    MainActivity -->|"UI events"| UpcomingVM
    MainActivity -->|"navigate to watchlist"| MovieVM

    %% ViewModel to Repository
    MovieVM -->|"getMovies() / getWatchlist()"| MovieRepo
    PopularVM -->|"fetchPopularMovies()"| MovieRepo
    TrendingVM -->|"fetchTrendingMovies()"| MovieRepo
    TopRatedVM -->|"fetchTopRatedMovies()"| MovieRepo
    UpcomingVM -->|"fetchUpcomingMovies()"| MovieRepo

    %% Repository to Remote & Local
    MovieRepo -->|"GET endpoints"| MovieApi
    MovieRepo -->|"loadPaging()"| PagingSource
    MovieRepo -->|"read/write watchlist"| MovieDB
    MovieRepo --> MovieDao
    MovieDao --> MovieItem

    %% Remote to External
    MovieApi -->|"HTTPS"| ExternalAPI
    PagingSource --> ExternalAPI

    %% Connectivity Observer to ViewModel
    ConnectivityObs -->|"network status"| MovieVM
    NetworkConnectivityObs --> MovieVM

    %% Factories to ViewModel
    MovieVMFactory --> MovieVM
    PopularVMFactory --> PopularVM
    TrendingVMFactory --> TrendingVM
    TopRatedVMFactory --> TopRatedVM
    UpcomingVMFactory --> UpcomingVM

    %% Models used by components
    MovieModel --> MovieApi
    ResponseModel --> MovieApi
    MovieModel --> MovieDB
    ResponseModel --> MovieRepo

    %% Utilities usage
    Constants --> MovieApi
    Constants --> MovieRepo
    Constants --> ViewModelLayer

    %% Styling
    classDef ui fill:#CCE5FF,stroke:#3399FF
    classDef vm fill:#CCE5FF,stroke:#3399FF
    classDef repo fill:#CCFFCC,stroke:#33CC33
    classDef network fill:#FFE5CC,stroke:#FF9933
    classDef db fill:#EEDDCC,stroke:#AA5533
    classDef obs fill:#DDDDDD,stroke:#888888
    classDef model fill:#F2E5FF,stroke:#9966CC
    classDef factory fill:#E5F2FF,stroke:#3399CC
    classDef util fill:#EEEEEE,stroke:#AAAAAA
    classDef external fill:#FFFFFF,stroke:#000000,stroke-dasharray: 5 5

    %% Click Events
    click MainActivity "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/MainActivity.kt"
    click UIComponents "https://github.com/himanshi-gupta/movieshow/tree/master/app/src/main/java/com/example/movieshow/ui/"
    click UITheme "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/ui/theme/Color.kt"
    click UITheme "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/ui/theme/Type.kt"
    click UITheme "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/ui/theme/Theme.kt"
    click Resources "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/res/values/strings.xml"
    click Resources "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/res/values/colors.xml"
    click Resources "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/res/values/themes.xml"
    click Resources "https://github.com/himanshi-gupta/movieshow/tree/master/app/src/main/res/drawable/"
    click MovieVM "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/viewModels/MovieViewModel.kt"
    click PopularVM "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/viewModels/PopularViewModel.kt"
    click TrendingVM "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/viewModels/TrendingViewModel.kt"
    click TopRatedVM "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/viewModels/TopRatedViewModel.kt"
    click UpcomingVM "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/viewModels/UpcompingViewModel.kt"
    click MovieRepo "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/repository/MovieRepo.kt"
    click MovieApi "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/network/MovieApi.kt"
    click PagingSource "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/paging/MoviePagingSource.kt"
    click MovieDB "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/database/MovieDatabase.kt"
    click MovieDao "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/database/MovieDao.kt"
    click MovieItem "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/database/MovieItem.kt"
    click ConnectivityObs "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/Observer/ConnectivityObserver.kt"
    click NetworkConnectivityObs "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/Observer/NetworkConnectivityObserver.kt"
    click MovieModel "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/models/Movie.kt"
    click ResponseModel "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/models/Response.kt"
    click MovieVMFactory "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/factory/MovieViewModelFactory.kt"
    click PopularVMFactory "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/factory/PopularViewModelFactory.kt"
    click TrendingVMFactory "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/factory/TrendingViewModelFactory.kt"
    click TopRatedVMFactory "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/factory/TopRatedViewModelFactory.kt"
    click UpcomingVMFactory "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/factory/UpcomingViewModeFactory.kt"
    click Constants "https://github.com/himanshi-gupta/movieshow/blob/master/app/src/main/java/com/example/movieshow/utils/Constants.kt"
```
