Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.46 KB

README.md

File metadata and controls

28 lines (18 loc) · 1.46 KB

Checkout API 🛒

Introdução

Este projeto implementa uma API de checkout utilizando a arquitetura Clean Architecture 🏛️, visando a criação de um sistema robusto, testável e de fácil manutenção. O design foca em separar claramente as responsabilidades através de diferentes camadas, garantindo a independência dos componentes e a possibilidade de evoluir cada parte do sistema de forma independente.

Arquitetura

A aplicação é dividida nas seguintes camadas:

  • Entities: O núcleo do nosso domínio, contém as entidades essenciais como Customer, Product, e Sale.
  • Use Cases: Orquestram o fluxo de negócios e dependem de interfaces para interagir com outras camadas.
  • Interface Adapters: Incluem adaptadores e mapeadores para converter dados entre as camadas de caso de uso e entidades, e entre entidades e os detalhes externos.
  • Frameworks & Drivers: Contém a implementação de frameworks e drivers como bancos de dados, UI, frameworks web, etc.

Executando o Projeto 🚀

Para rodar o projeto localmente, siga os passos abaixo:

  1. Clone o repositório.
  2. Instale as dependências com yarn install ou npm install.
  3. Configure as variáveis de ambiente conforme o exemplo no arquivo .env.template.
  4. Execute o comando docker-compose up para iniciar os contêineres necessários.
  5. Acesse http://localhost:3333 para ver a API em funcionamento.

Desenvolvido com ❤️ por @jeanvcastro