How matheusguermandi/advanced-node works
Project type and purpose
• This is a backend API project written in TypeScript, following Clean Architecture and DDD principles.
• It exposes HTTP endpoints for Facebook authentication and profile‐picture changes, persisting user data in Postgres and files in S3.
File structure
• Top‐level layers under src/ mirror Clean Architecture:
• src/main – Composition Root, Express adapters, route wiring, middleware, configuration
• src/application – Use‐case controllers, request validation, transaction decorators, HTTP helpers
• src/domain – Core business rules: entities, use‐case interfaces (contracts), domain errors
• src/infra – Implementations of domain contracts: Postgres repos, AWS S3 gateway, Facebook API, JWT/UUID handlers
• Factories in src/main/factories assemble controllers, use cases and infra implementations via the Factory pattern.
• Config files (ormconfig.json, .env), build & test configs (Jest, Travis, tsconfig) and documentation use‐cases in /documentation.
README for additional insights
• Emphasis on SOLID, Clean Architecture, TDD, and patterns (Factory, Adapter, Decorator, Composite, etc.).
• Two primary use cases illustrated: Facebook authentication and change‐profile‐picture.
a. Main components
1. HTTP Layer – Express server, routers, middleware, multer adapter
2. Application Layer – Controllers, decorators (DB transaction), validators
3. Domain Layer – Use‐case interfaces, business logic, entities, domain errors
4. Infrastructure Layer –
• Postgres DB (via TypeORM)
• AWS S3 for file storage
• External Facebook API (via Axios)
• JWT token service, UUID generator
b. Relationships / data flows
• Client HTTP → Express Router → Controller
• Controller invokes Use‐Case interface → Domain logic → Domain entities
• Use‐Case calls Gateway / Repository interfaces → Infra implementations
• Infra returns data → Domain → Controller → HTTP Response
c. Architectural patterns / principles
• Clean Architecture (layered, dependency inversion)
• Factories & Dependency Injection (in src/main/factories)
• Adapter Pattern (Express middleware, Axios‐based Facebook API client)
• Decorator Pattern (DB transaction wrapper around controllers)
• Composite & Builder Pattern (validation rules composition)
d. Key technologies & libraries
• Typescript, Express, TypeORM, AWS‐SDK (S3), Axios, Multer, JWT, UUID, Postgres, Jest