# fabio-beutler/clean-react architecture

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

- Interactive diagram: https://gitdiagram.com/fabio-beutler/clean-react
- Repository: https://github.com/fabio-beutler/clean-react

## Overview

##### High-Level Architecture Layers

a) Domain Layer (Core)
- Domain entities (Account, Survey)
- Use cases (Authentication, AddAccount, LoadSurveyList)

b) Data Layer
- RemoteAuthentication, RemoteAddAccount, RemoteLoadSurveyList
- HTTP and Cache protocols

c) Presentation Layer
- React components hierarchy
- Pages (Login, Signup, SurveyList)
- Contexts and hooks

d) Main Layer (Composition Root)
- Factories and composition
- Adapters and decorators

##### Infrastructure Components
- AxiosHttpClient
- LocalStorageAdapter
- CookiesAdapter

##### External Dependencies
External services and libraries:
- React
- Axios
- Testing tools (Jest, Cypress, RTL)

##### Data Flow
- User interactions flow
- API calls flow
- Data persistence flow
- Authentication flow

##### Cross-Cutting Concerns
- Validation system
- Error handling
- Authentication/Authorization

Key Elements to Include:

##### Component Relationships
**Frontend (Presentation) → Data Layer → Domain Layer**
**↑**
**Infrastructure Layer (Axios, Storage) → External APIs**

##### Authentication Flow
**Login/Signup Components → RemoteAuthentication → Domain Authentication → External API**

##### Survey Flow
**SurveyList Component → RemoteLoadSurveyList → Domain SurveyList → External API**

Important Considerations:

##### Use standardized symbols
- Rectangles: Components and modules
- Circles: Clean Architecture layers
- Clouds: External services

##### Notes for
- Design patterns used (Factory, Adapter, Decorator)
- SOLID principles implementation points
- Testing boundaries

##### Cross-Cutting Concerns
- Error handling
- Validation
- Authentication
- Caching

- Clean Architecture separation
- Dependency flow (always pointing inward)
- Clear boundaries between layers
- Testing possibilities at each layer
- Factory pattern usage for dependency injection
- Decorator pattern for cross-cutting concerns

Remember to maintain a balance between detail and clarity, focusing on the architectural decisions while avoiding implementation details that don't contribute to understanding the system's structure.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Clean Architecture Layers
    subgraph Domain["Domain Layer"]
        DomainEntities["Domain Entities"]:::domain
        DomainUseCases["Domain Use Cases"]:::domain
        DomainErrors["Domain Errors"]:::domain
    end

    subgraph Data["Data Layer"]
        RemoteAuth["Remote Authentication"]:::data
        RemoteAddAcc["Remote Add Account"]:::data
        RemoteLoadSurvey["Remote Load Survey List"]:::data
        HttpProtocols["HTTP Protocols"]:::data
        CacheProtocols["Cache Protocols"]:::data
    end

    subgraph Presentation["Presentation Layer"]
        Pages["Pages"]:::presentation
        Components["Components"]:::presentation
        Contexts["Contexts"]:::presentation
        Hooks["Hooks"]:::presentation
    end

    subgraph Main["Main Layer (Composition Root)"]
        Factories["Factories"]:::main
        Adapters["Adapters"]:::main
        Decorators["Decorators"]:::main
    end

    subgraph Infrastructure["Infrastructure Layer"]
        AxiosClient["Axios HTTP Client"]:::infra
        LocalStorage["Local Storage Adapter"]:::infra
        CookiesAdapter["Cookies Adapter"]:::infra
    end

    subgraph Validation["Validation System"]
        Validators["Validators"]:::validation
        ValidationBuilder["Validation Builder"]:::validation
        ValidationProtocols["Validation Protocols"]:::validation
    end

    %% Relationships
    Pages --> RemoteAuth
    Pages --> RemoteAddAcc
    Pages --> RemoteLoadSurvey
    
    RemoteAuth --> DomainUseCases
    RemoteAddAcc --> DomainUseCases
    RemoteLoadSurvey --> DomainUseCases
    
    DomainUseCases --> DomainEntities
    
    HttpProtocols --> AxiosClient
    CacheProtocols --> LocalStorage
    CacheProtocols --> CookiesAdapter
    
    Factories --> Pages
    Factories --> Components
    
    Components --> Hooks
    Components --> Contexts
    
    Validators --> ValidationBuilder
    ValidationBuilder --> ValidationProtocols
    
    %% Click Events
    click DomainEntities "https://github.com/fabio-beutler/clean-react/tree/main/src/domain/models/"
    click DomainUseCases "https://github.com/fabio-beutler/clean-react/tree/main/src/domain/useCases/"
    click DomainErrors "https://github.com/fabio-beutler/clean-react/tree/main/src/domain/errors/"
    click RemoteAuth "https://github.com/fabio-beutler/clean-react/blob/main/src/data/useCases/authentication/remoteAuthentication.ts"
    click RemoteAddAcc "https://github.com/fabio-beutler/clean-react/blob/main/src/data/useCases/addAccount/remoteAddAccount.ts"
    click RemoteLoadSurvey "https://github.com/fabio-beutler/clean-react/blob/main/src/data/useCases/loadSurveyList/remoteLoadSurveyList.ts"
    click HttpProtocols "https://github.com/fabio-beutler/clean-react/tree/main/src/data/protocols/http/"
    click CacheProtocols "https://github.com/fabio-beutler/clean-react/tree/main/src/data/protocols/cache/"
    click Pages "https://github.com/fabio-beutler/clean-react/tree/main/src/presentation/pages/"
    click Components "https://github.com/fabio-beutler/clean-react/tree/main/src/presentation/components/"
    click Contexts "https://github.com/fabio-beutler/clean-react/tree/main/src/presentation/contexts/"
    click Hooks "https://github.com/fabio-beutler/clean-react/tree/main/src/presentation/hooks/"
    click AxiosClient "https://github.com/fabio-beutler/clean-react/tree/main/src/infra/http/axiosHttpClient/"
    click LocalStorage "https://github.com/fabio-beutler/clean-react/tree/main/src/infra/cache/localStorageAdapter/"
    click CookiesAdapter "https://github.com/fabio-beutler/clean-react/tree/main/src/infra/cache/cookiesAdapter/"
    click Factories "https://github.com/fabio-beutler/clean-react/tree/main/src/main/factories/"
    click Adapters "https://github.com/fabio-beutler/clean-react/tree/main/src/main/adapters/"
    click Decorators "https://github.com/fabio-beutler/clean-react/tree/main/src/main/decorators/"
    click Validators "https://github.com/fabio-beutler/clean-react/tree/main/src/validation/validators/"
    click ValidationBuilder "https://github.com/fabio-beutler/clean-react/tree/main/src/validation/builder/"
    click ValidationProtocols "https://github.com/fabio-beutler/clean-react/tree/main/src/validation/protocols/"

    %% Styles
    classDef domain fill:#a8dadc,stroke:#1d3557,color:#1d3557
    classDef data fill:#ffd166,stroke:#073b4c,color:#073b4c
    classDef presentation fill:#ff9f1c,stroke:#011627,color:#011627
    classDef main fill:#7209b7,stroke:#f8f9fa,color:#f8f9fa
    classDef infra fill:#8d99ae,stroke:#2b2d42,color:#2b2d42
    classDef validation fill:#06d6a0,stroke:#073b4c,color:#073b4c

    %% Legend
    subgraph Legend
        DomainLegend["Domain"]:::domain
        DataLegend["Data"]:::data
        PresentationLegend["Presentation"]:::presentation
        MainLegend["Main"]:::main
        InfraLegend["Infrastructure"]:::infra
        ValidationLegend["Validation"]:::validation
    end
```
