How rmanguinho/clean-react works
Project type and purpose
• This is a front‐end React application (“4Dev React – Enquetes para Programadores”) built with TypeScript, using Clean Architecture and TDD.
• It implements a survey system that consumes a remote REST API (http://fordevs.herokuapp.com/api-docs), caches data in localStorage, and follows SOLID, DRY, KISS.
File structure
• Top‐level:
• public/ + template HTMLs (webpack entry points)
• src/ – contains all application code, subdivided into layers: presentation, main, data, domain, infra, validation
• tests/ – unit, integration and E2E (Cypress) tests
• Layers and patterns:
• presentation/ – React components, pages, hooks (UI layer)
• main/ – composition root: factories, adapters, decorators, routes (wiring + DI)
• data/ – usecases implementations, models, protocols (repository pattern)
• domain/ – business models, use‐case interfaces, domain errors
• infra/ – concrete HTTP (Axios) and cache (localStorage) adapters
• validation/ – field‐validation protocols and validators
• Build & CI: ESLint, Husky, Jest, Cypress, TravisCI, Webpack configs.
README insights
• Emphasis on Clean Architecture, SOLID, TDD.
• Lists design patterns used: Factory, Adapter, Composite, Decorator, Proxy, Builder.
• Technology stack: React + Hooks + Recoil, TypeScript, Axios, Cypress, Jest.
a. Main components
• Presentation Layer (React UI – pages & components)
• Main/Composition Root (factories, decorators, router)
• Domain Layer (use‐case interfaces + business models + errors)
• Data Layer (use‐case implementations, data models, protocol interfaces)
• Infra Layer (HTTP client adapter, localStorage adapter)
• External Services (Remote API, Browser LocalStorage)
b. Relationships & interactions
1. UI invokes a use‐case via a factory from main/
2. Factory wires: UseCaseInteractor (data/) implements DomainInterface
3. UseCaseInteractor depends on HTTPClientProtocol and CacheProtocol (data/protocols)
4. HTTPClientProtocol decorator (authorize‐http‐client‐decorator) wraps AxiosHttpClient (infra/http)
5. CacheProtocol implemented by LocalStorageAdapter (infra/cache)
6. HTTPClient → Remote API; LocalStorage → Browser localStorage
7. Responses propagate back through UseCase → UI for rendering
c. Architectural patterns & principles
• Clean Architecture layers, Dependency Inversion: domain interfaces implemented by data layer, wired in main.
• Factories as Composition Root, Decorator for HTTP client authorization, Proxy for private-route.
• Builder & Composite for validation rules.
d. Key technologies
• React + Hooks + Recoil (state management)
• TypeScript (typing + modules)
• Axios for HTTP, localStorage for caching
• Webpack for bundling, Jest & React Testing Library for unit tests, Cypress for E2E
Essential elements
• Clear labels (e.g., “SurveyListPage”, “RemoteLoadSurveyListUseCase”, “AuthorizeHttpClientDecorator”).
• Annotations for design patterns at work (e.g., “Factory”, “Decorator”).