# vancelopes/composecat architecture

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

- Interactive diagram: https://gitdiagram.com/vancelopes/composecat
- Repository: https://github.com/vancelopes/composecat

## Overview

##### Main Architectural Components

A. Presentation Layer (UI)
- Jetpack Compose components
- CatListScreen
- CatViewItem
- Theme components
- ViewModel (CatsViewModel)

B. Domain Layer
- Use Cases (GetCats)
- Repository Interfaces
- Domain Models (Cat)

C. Data Layer
- Repository Implementation
- API Services
- DTOs (Data Transfer Objects)
- Network Infrastructure

##### Dependencies and Injection Layer
- Dependency Injection modules (Hilt/Dagger)
- ApiModule
- CatRepositoryModule
- GetCatsUseCaseModule

**┌─────────────────────────────────────────────────────┐**
- Presentation Layer                  │
- ┌─────────────┐    ┌─────────────┐                │
- ComposableUI │←───│ViewModel    │                │
- ┘    └─────────────┘                │
- ┬─────────────────────────┘
- ↓
**┌─────────────────────────────────────────────────────┐**
- Domain Layer                      │
- ┌─────────────┐    ┌─────────────┐                │
- Use Cases  │←───│Repository   │                │
- Interface    │                │
- ┘    └─────────────┘                │
- ┬─────────────────────────┘
- ↓
**┌─────────────────────────────────────────────────────┐**
- Data Layer                        │
- ┌─────────────┐    ┌─────────────┐                │
- Repository   │←───│   API       │                │
- Implementation│    │  Service    │                │
- ┘    └─────────────┘                │
- ┘

##### Data Flow Representation
- Flow of data from API to UI

##### Detailed Component Breakdown

A. Presentation Layer Details:
- CatListScreen (Composable)
- CatViewItem (Composable)
- CatsViewModel
- UI Theme components

B. Domain Layer Details:
- GetCats UseCase
- CatRepository Interface
- Cat Domain Model

C. Data Layer Details:
- CatRepositoryImpl
- CatApi and CatApiService
- RequestInterceptor
- CatDto

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef presentation fill:#e1f5fe,stroke:#01579b
    classDef domain fill:#e8f5e9,stroke:#1b5e20
    classDef data fill:#fff3e0,stroke:#e65100
    classDef di fill:#f3e5f5,stroke:#4a148c
    classDef common fill:#eceff1,stroke:#263238

    %% Presentation Layer
    subgraph PresentationLayer["Presentation Layer"]
        UI["UI Components"]
        CatListScreen["CatListScreen"]
        CatViewItem["CatViewItem"]
        Theme["Theme Components"]
        CatsViewModel["CatsViewModel"]
        
        UI --> CatListScreen
        UI --> CatViewItem
        UI --> Theme
        CatListScreen --> CatsViewModel
    end

    %% Domain Layer
    subgraph DomainLayer["Domain Layer"]
        GetCats["GetCats UseCase"]
        CatRepository["Cat Repository Interface"]
        CatModel["Cat Domain Model"]
        
        GetCats --> CatRepository
        GetCats --> CatModel
    end

    %% Data Layer
    subgraph DataLayer["Data Layer"]
        CatRepositoryImpl["Cat Repository Implementation"]
        CatApiService["Cat API Service"]
        CatDto["Cat DTO"]
        RequestInterceptor["Request Interceptor"]
        
        CatRepositoryImpl --> CatApiService
        CatApiService --> RequestInterceptor
        CatApiService --> CatDto
    end

    %% Dependency Injection
    subgraph DI["Dependency Injection"]
        ApiModule["API Module"]
        CatRepoModule["Cat Repository Module"]
        GetCatsModule["GetCats UseCase Module"]
        
        ApiModule --> CatRepoModule
        CatRepoModule --> GetCatsModule
    end

    %% Common Components
    Resource["Resource Class"]
    Application["ComposeCat Application"]

    %% Relationships between layers
    CatsViewModel --> GetCats
    CatRepository --> CatRepositoryImpl
    DI --> Application

    %% Click events for component mapping
    click CatListScreen "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/presentation/catlist/CatListScreen.kt"
    click CatViewItem "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/presentation/ui/item/CatViewItem.kt"
    click CatsViewModel "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/presentation/CatsViewModel.kt"
    click Theme "https://github.com/vancelopes/composecat/tree/main/app/src/main/java/com/vancelopes/composecat/presentation/ui/theme"
    click GetCats "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/domain/usecase/GetCats.kt"
    click CatRepository "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/domain/repository/CatRepository.kt"
    click CatModel "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/domain/model/Cat.kt"
    click CatRepositoryImpl "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/domain/repository/CatRepositoryImpl.kt"
    click CatApiService "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/data/api/CatApiService.kt"
    click CatDto "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/data/dto/CatDto.kt"
    click RequestInterceptor "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/data/api/RequestInterceptor.kt"
    click ApiModule "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/di/ApiModule.kt"
    click CatRepoModule "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/di/CatRepositoryModule.kt"
    click GetCatsModule "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/di/GetCatsUseCaseModule.kt"
    click Resource "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/common/Resource.kt"
    click Application "https://github.com/vancelopes/composecat/blob/main/app/src/main/java/com/vancelopes/composecat/ComposeCatApplication.kt"

    %% Style applications
    class CatListScreen,CatViewItem,Theme,CatsViewModel,UI presentation
    class GetCats,CatRepository,CatModel domain
    class CatRepositoryImpl,CatApiService,CatDto,RequestInterceptor data
    class ApiModule,CatRepoModule,GetCatsModule di
    class Resource,Application common
```
