E-Commerce API (WIP)

Este projeto é uma API de um e-commerce básico, o objetivo principal é demonstrar de forma prática e aplicada os conhecimentos adquiridos em desenvolvimento, especialmente nos princípios de arquitetura de software e design patterns com Node.js, porém sem a utilização de frameworks que facilitariam o desenvolvimento como o Nest.js. No momento, este projeto está ainda em desenvolvimento e apenas a funcionalidade de cadastro de produtos foi implementada, servindo como ponto de partida para a expansão do sistema.

Arquitetura de Software e Design Patterns

O projeto segue uma arquitetura modular inspirada nos princípios da Clean Architecture. A estrutura em camadas (domínio, aplicação e infraestrutura) permite uma separação clara de responsabilidades e facilita a manutenção.

Estrutura do Projeto

src/
├── @types
│   ├── global.d.ts
│   └── http.d.ts
├── index.ts
├── infra
│   ├── database
│   │   └── memory
│   │       └── memory-database.ts
│   └── http
│       ├── express
│       │   └── express-http.server.adapter.ts
│       └── http.server.ts
├── modules
│   ├── auth
│   │   └── infra
│   └── products
│       ├── application
│       │   ├── create-product.usecase.test.ts
│       │   ├── create-product.usecase.ts
│       │   ├── find-by-id-product.usecase.test.ts
│       │   ├── find-by-id-product.usecase.ts
│       │   └── ...
│       ├── domain
│       │   ├── dtos
│       │   │   ├── create-product.dto.ts
│       │   │   ├── find-product.dto.ts
│       │   │   └── ...
│       │   ├── product.entity.test.ts
│       │   ├── product.entity.ts
│       │   ├── product.mapper.test.ts
│       │   ├── product.mapper.ts
│       │   └── product.repository.ts
│       └── infra
│           ├── controllers
│           │   ├── create-product.controller.ts
│           │   ├── find-many-product.controller.ts
│           │   ├── product.factory.ts
│           │   └── ...
│           └── database
│               └── memory-product.repository.ts
└── shared
    ├── errors
    │   ├── app.error.test.ts
    │   ├── app.error.ts
    │   ├── bad-request.error.ts
    │   └── ...
    ├── logger
    │   └── logger.ts
    ├── result
    │   ├── result.test.ts
    │   └── result.ts
    └── value-objects
        ├── id.test.ts
        ├── id.ts
        ├── name.test.ts
        ├── name.ts
        └── ...

Possíveis Melhorias e Futuras Implementações

Embora o projeto seja apenas para fins educacionais, segue algumas possíveis futuras melhorias e implementações:

• Testes Mais Abrangentes: Expandir a cobertura de testes para garantir uma robustez ainda maior, abrangendo diferentes cenários e casos de uso.

• Documentação Aprimorada: Elaborar documentação mais detalhada, incluindo informações sobre endpoints da API, fluxos de dados e possíveis configurações.

• Refatoração de Código: Realizar refatorações pontuais para aprimorar a legibilidade, modularidade e manutenibilidade do código.

• Gestão de Logs Aprimorada: Implementar um sistema de log mais robusto para facilitar a detecção e resolução de problemas em ambientes de produção.

• Módulo de Usuários: Adicionar um módulo de gestão de usuários, com funcionalidades como registro, autenticação, e gerenciamento do perfil.

• Módulo de pedidos: Implementar um módulo para gerenciamento de pedidos, incluindo criação, atualização, e consulta de pedidos realizados pelos usuários.

• Módulo de Carrinho de Compras: Desenvolver um módulo para controle de carrinhos de compras, permitindo aos usuários adicionar/remover produtos antes de efetuar a compra.

• Módulo de Pagamentos: Implementar um módulo para processamento de pagamentos, integrando diferentes métodos de pagamento.

• Eventos de Domínio: Implementação de eventos de domínio para aprimorar a comunicação assíncrona entre diferentes partes do sistema. Isso pode melhorar a escalabilidade e a flexibilidade da arquitetura, permitindo que diferentes componentes reajam a eventos específicos sem acoplamento direto.

• Separação em Microserviços: Divisão da aplicação em microserviços independentes, cada um responsável por funcionalidades específicas. Uma abordagem sugerida seria organizar o código em um monorepo.

• CI/CD: Implementação de pipelines de CI/CD para garantir que as mudanças do código sejam automatizadas e testadas automaticamente.

• Utilização de Serviços de Mensageria: Integre serviços de mensageria para facilitar a comunicação entre microserviços. O uso de uma infraestrutura de mensageria, como RabbitMQ ou Kafka, pode melhorar a confiabilidade e a eficiência na troca de informações entre os diferentes componentes do sistema.

Como Iniciar

Certifique-se de ter o Node.js instalado. Clone o repositório e execute os seguintes passos:

# Instale as dependências
yarn install

# Execute a aplicação em modo de desenvolvimento
yarn dev

Testes

Para executar os testes, utilize o seguinte comando:

yarn test

Build

Para executar o build e compilar o projeto, utilize o seguinte comando:

yarn build && yarn start

Rotas

• Test: OPTIONS /

• Criar Produto: POST /products

• Buscar Produto por ID: GET /products/:id

• Buscar Múltiplos Produtos: GET /products

• Atualizar Produto por ID: PATCH /products/:id

Lembre-se

Este projeto é destinado apenas a fins educacionais.