# sahinkaradeniz/rickandmortyapp architecture

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

- Interactive diagram: https://gitdiagram.com/sahinkaradeniz/rickandmortyapp
- Repository: https://github.com/sahinkaradeniz/rickandmortyapp

## Overview

##### Main Components

a. Presentation Layer (UI)
- Activities and Fragments (SplashFragment, HomeFragment, DetailFragment)
- ViewModels (HomeViewModel, DetailViewModel)
- UI States and Adapters
- Custom Components

b. Domain Layer
- Use Cases
- Entity Models
- Repository Interfaces

c. Data Layer
- Repository Implementations
- Remote Data Source
- API Service
- DTOs (Data Transfer Objects)
- Mappers

d. Common Module
- Utilities
- Extensions
- Common Components

##### Architecture Pattern

**UI Layer → Domain Layer ← Data Layer**

##### Key Elements to Highlight

a. Data Flow
- How data flows from the API through the layers:
API → RemoteDataSource → Repository → UseCase → ViewModel → UI

b. Dependencies
- Dependency injection with Hilt
- Module dependencies between layers

##### Specific Implementation Details

**[UI Layer]**
- Activities/Fragments
- SplashFragment
- HomeFragment
- DetailFragment
- ViewModels
- HomeViewModel
- DetailViewModel
- UI States
- Adapters

**[Domain Layer]**
- Use Cases
- GetCharacterWithIdUseCase
- GetCharacterLocationWithIdsUseCase
- GetLocationPagingDataSourceUseCase
- Entities
- CharacterEntity
- LocationEntity
- Repository Interfaces

**[Data Layer]**
- Repository Implementation
- Remote Data Source
- API Service (RickAndMortyApi)
- DTOs
- Character DTOs
- Location DTOs
- Mappers

**[Common Module]**
- Extensions
- Utils
- Network Results

##### Technical Stack Integration
How these technologies interact:
- Retrofit for API calls
- Coroutines & Flow for async operations
- Paging 3 for pagination
- Hilt for dependency injection
- Navigation Component for navigation between fragments

##### Important Relationships
- Navigation flow between fragments
- Data flow through the layers
- Dependency injection connections
- Paging data flow for location list
- API communication pattern

##### Additional Elements
- Notes about key architectural decisions
- Error handling flow

Remember to maintain a balance between detail and clarity, focusing on the architectural decisions while avoiding overwhelming detail about implementation specifics.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef domain fill:#2ecc71,stroke:#27ae60,color:white
    classDef data fill:#f1c40f,stroke:#f39c12,color:black
    classDef common fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef external fill:#e74c3c,stroke:#c0392b,color:white

    %% Legend
    subgraph Legend
        UI[UI Components]:::ui
        Domain[Domain Layer]:::domain
        Data[Data Layer]:::data
        Common[Common Utilities]:::common
        External[External Services]:::external
    end

    %% UI Layer
    subgraph UI_Layer[Presentation Layer]
        Fragments[Fragments]
        click Fragments "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/app/src/main/java/com/example/rickandmorty/ui/"
        ViewModels[ViewModels]
        UIStates[UI States]
        click UIStates "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/app/src/main/java/com/example/rickandmorty/ui/home/HomeUiState.kt"
        Adapters[Adapters]
        click Adapters "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/app/src/main/java/com/example/rickandmorty/ui/home/adapter/"

        HomeVM[HomeViewModel]
        click HomeVM "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/app/src/main/java/com/example/rickandmorty/ui/home/HomeViewModel.kt"
        DetailVM[DetailViewModel]
        click DetailVM "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/app/src/main/java/com/example/rickandmorty/ui/detail/DetailViewModel.kt"
    end

    %% Domain Layer
    subgraph Domain_Layer[Domain Layer]
        UseCases[Use Cases]
        click UseCases "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/domain/src/main/java/com/example/domain/usecase/"
        Entities[Entity Models]
        click Entities "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/domain/src/main/java/com/example/domain/entity/"
        RepoInterfaces[Repository Interfaces]
        click RepoInterfaces "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/domain/src/main/java/com/example/domain/repository/RickAndMortyRepository.kt"
    end

    %% Data Layer
    subgraph Data_Layer[Data Layer]
        RepoImpl[Repository Implementation]
        click RepoImpl "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/data/src/main/java/com/example/data/repository/RickAndMortyRepositoryImpl.kt"
        RemoteDS[Remote Data Source]
        click RemoteDS "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/data/src/main/java/com/example/data/source/RemoteDataSource.kt"
        ApiService[Rick and Morty API]
        click ApiService "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/data/src/main/java/com/example/data/api/RickAndMortyApi.kt"
        DTOs[DTOs]
        click DTOs "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/data/src/main/java/com/example/data/dto/"
        Mappers[Mappers]
        click Mappers "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/data/src/main/java/com/example/data/mapper/"
    end

    %% Common Module
    subgraph Common_Module[Common Module]
        Extensions[Extensions]
        click Extensions "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/common/src/main/java/com/example/common/extension/"
        Utils[Utilities]
        click Utils "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/common/src/main/java/com/example/common/util/"
        NetworkResults[Network Results]
        click NetworkResults "https://github.com/sahinkaradeniz/RickAndMortyApp/blob/main/common/src/main/java/com/example/common/NetworkResult.kt"
    end

    %% Dependencies and DI
    subgraph DI[Dependency Injection]
        HiltModules[Hilt Modules]
        click HiltModules "https://github.com/sahinkaradeniz/RickAndMortyApp/tree/main/data/src/main/java/com/example/data/di/"
    end

    %% External Services
    subgraph External[External Dependencies]
        Retrofit[Retrofit]
        Coroutines[Coroutines & Flow]
        Paging[Paging 3]
        Navigation[Navigation Component]
    end

    %% Relationships
    ApiService --> RemoteDS
    RemoteDS --> RepoImpl
    RepoImpl --> RepoInterfaces
    RepoInterfaces --> UseCases
    UseCases --> ViewModels
    ViewModels --> Fragments
    DTOs --> Mappers
    Mappers --> Entities
    
    %% DI Connections
    HiltModules -.-> RepoImpl
    HiltModules -.-> UseCases
    HiltModules -.-> ViewModels

    %% External Service Usage
    Retrofit -.-> ApiService
    Coroutines -.-> ViewModels
    Paging -.-> Adapters
    Navigation -.-> Fragments

    %% Common Module Usage
    NetworkResults -.-> RepoImpl
    Extensions -.-> Fragments
    Utils -.-> ViewModels

    %% Style Applications
    class UI_Layer,Fragments,ViewModels,UIStates,Adapters,HomeVM,DetailVM ui
    class Domain_Layer,UseCases,Entities,RepoInterfaces domain
    class Data_Layer,RepoImpl,RemoteDS,ApiService,DTOs,Mappers data
    class Common_Module,Extensions,Utils,NetworkResults common
    class External,Retrofit,Coroutines,Paging,Navigation external
    class DI,HiltModules common
```
