yaralviana / projeto-integrador-banco-comunitario

API for practicing NestJS, TypeORM, Hexagonal Architecture, Jest and CI/CD.

{Astra}CommunityBank

Como testar

Clone o repositório:

git clone https://github.com/yaralviana/astra-community-bank

Entre na pasta do projeto:

cd astra-community-bank

Executar o projeto

• Instalação das dependências:

npm i

• Execução

npm run start:dev

Rotas para Gerenciamento de Gerentes

• GET http://localhost:3000/managers

  • Descrição: Obtém todos os gerentes.

• GET http://localhost:3000/managers/:id

  • Descrição: Obtém um gerente pelo ID.

• POST http://localhost:3000/managers

  • Descrição: Cria um novo gerente.
  • Corpo da requisição:

    {
      "fullName": "Lzzy Hale"
    }

• PUT http://localhost:3000/managers/:id

  • Descrição: Atualiza os detalhes de um gerente existente pelo ID.
  • Corpo da requisição:

    {
      "fullName": "Lzzy Hale Hyde"
    }

• DELETE http://localhost:3000/managers/:id

  • Descrição: Exclui um gerente pelo ID.

Rotas para Gerenciamento de Clientes sob um Gerente

• POST http://localhost:3000/managers/:managerId/customers

  • Descrição: Adiciona um cliente sob a responsabilidade de um gerente.

  • Corpo da requisição:

    {
      "fullName": "Alice no País das Maravilhas",
      "address": "Rua das pedras bem brilhantes, nº 0",
      "phone": "27999999999"
    }

• DELETE http://localhost:3000/managers/:managerId/customers/:customerId

  • Descrição: Remove um cliente da responsabilidade de um gerente pelo ID do cliente.

• GET http://localhost:3000/managers/:managerId/customers

  • Descrição: Obtém todos os clientes sob a responsabilidade de um gerente.

Rotas para Gerenciamento de Contas de um Cliente sob um Gerente

• POST http://localhost:3000/managers/:managerId/customers/:customerId/accounts

  • Descrição: Abre uma conta para um cliente sob a responsabilidade de um gerente.
  • Corpo da requisição:

    {
      "type": "savings",
      "extra": 1000
    }

• DELETE http://localhost:3000/managers/:managerId/customers/:customerId/accounts/:accountType

  • Descrição: Fecha uma conta de um cliente sob a responsabilidade de um gerente pelo tipo de conta.

• PUT http://localhost:3000/managers/:managerId/customers/:customerId/accounts/:accountType

  • Descrição: Modifica o tipo de uma conta de um cliente sob a responsabilidade de um gerente.
  • Corpo da requisição:

    {
      "newType": "checking"
    }

• GET http://localhost:3000/managers/:managerId/customers/:customerId/accounts

  • Descrição: Obtém todas as contas de um cliente sob a responsabilidade de um gerente.

Testes de Rotas para Processamento de Pagamentos

• POST http://localhost:3000/accounts/:customerId/:type/pay
  • Descrição: Requisição para efetuar pagamento. No exemplo abaixo é utilizado o pagamento via PIX.
  • Corpo da requisição:

    {
      "amount": 100.0,
      "paymentType": "PIX",
      "paymentDetail": "abc123pixkey"
    }

Críticas e sugestões são muito bem-vindas. 💜

projeto-integrador-banco-comunitario's Issues

Readme em inglês

Adicionar testes de integração e github workflow

Modificar para TypeORM

Objetivos de aprendizagem do desafio 🎯

• Adicionar um banco de dados PostgreSQL à aplicação Reprograma Bank, implementar a gestão de transações, acessíveis a todos os clientes.

Implementação:

• Configurar o banco de dados PostgreSQL.
• Integrar um ORM (por exemplo, TypeORM ou Sequelize) para gerenciar interações com o banco de dados.
• Implementar funcionalidade para registrar e consultar transações de depósito, saque e transferência nas contas.

Ajustes pós review - semana 04

Registrar a data e hora do saque

Migrar para arquitetura hexagonal

Exemplos usados em aula:
https://github.com/jeniferplacido/banco-hexagonal

https://github.com/jeniferplacido/monolithic-bank/

Desafio - Semana 04

Objetivos de aprendizagem do desafio 🎯

Explorar práticas recomendadas para criar um design de código claro e eficiente
Aplicar SOLID, DRY e KISS
Implementar padrões de código PD_Factory, PD_Adapter, PD_Observer
Identificar como os padrões de design influenciam a estrutura e organização de um sistema.

{Reprograma}Bank - melhorando nossa aplicação

Nesta semana, o desafio é refatorar a aplicação desenvolvida anteriormente, aplicando práticas recomendadas para criar um design de código e eficiente. Além disso, serão aplicados os princípios SOLID (Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion), DRY (Don't Repeat Yourself), KISS (Keep It Simple, Stupid) e alguns padrões de design, como Factory, Adapter e Observer.

Requisitos de negócio:

• Adicionar a capacidade de realizar pagamentos de contas por PIX ou número de boleto.
• O cliente deve possuir saldo em conta ou limite no cheque especial para efetuar a transação.

Sugestão de Estrutura de Pastas:

reprograma-bank/
├── src/
│ ├── controllers/
│ │ └── xxxController.ts
│ ├── models/
│ │ └── xxxModel.ts
│ ├── routes/
│ │ └── xxxRoutes.ts
│ ├── services/
│ │ └── xxxService.ts
│ └── index.ts
├── node_modules/
├── package.json
├── tsconfig.json
└── README.md

Na estrutura sugerida:

src/controllers/: Contém os controladores para manipular as requisições HTTP, lidando principalmente com a interação entre a API e o modelo de dados.
src/models/: Armazena os modelos de dados das entidades Cliente, Gerente e Conta, representando a estrutura de dados da aplicação.
src/routes/: Define as rotas da API para cada entidade, mapeando as solicitações HTTP para as funções correspondentes nos controladores.
src/services/: Armazena os serviços responsáveis por implementar a lógica de negócios da aplicação, mantendo a separação de responsabilidades e facilitando a reutilização do código.
src/index.ts: Arquivo principal que inicializa o servidor e conecta-se ao banco de dados, fornecendo a entrada para a aplicação.

Autenticação nas rotas

Atividade para casa - Semana 03

Desafio Semanal

Objetivos de aprendizagem do desafio 🎯

• Entender como o TypeScript, uma linguagem de programação superset de JavaScript, se integra naturalmente ao ecossistema do Node.js.
• Compreender os princípios e características de uma arquitetura RESTful.
• Identificar os recursos, URIs, métodos HTTP e códigos de status comuns em uma API REST.
• Aprender a projetar e implementar uma API RESTful usando Node.js, seguindo as melhores práticas de REST.

{Reprograma}Bank

Disponibilizando nossa API

Seu desafio é criar uma API RESTful para o sistema bancário desenvolvido na semana 2, agora incluindo a funcionalidade de Gerente de Conta. O Gerente é responsável por gerenciar os clientes e suas contas, podendo abrir, fechar e modificar o tipo de conta.

Abaixo estão os requisitos:

Ao cliente do banco ser adicionadas as seguintes informações:

• Contas
• Gerente

Gerente deve ter as seguintes informações:

• Nome completo
• Número de identificação (ID)
• Clientes

Requisitos de negócio:

• Criar classes para representar Cliente e Gerente, incluindo os atributos mencionados no diagrama.
• Implementar métodos nas classes Cliente e Gerente para abrir, fechar e modificar o tipo de conta.
• Atualizar a classe Conta para manter uma referência ao cliente associado a ela.
• Implementar métodos na classe Gerente para adicionar e remover clientes, bem como para abrir, fechar e modificar o tipo de conta para um determinado cliente.
• Organizar a estrutura do projeto de forma apropriada, seguindo as melhores práticas para uma API RESTful.

Diagrama:

+---------------------------------+
|           Cliente               |
+---------------------------------+
| - nomeCompleto: string          |
| - id: string                    |
| - endereco: string              |
| - telefone: string              |
| - contas: ContaBancaria[]       |
| - gerente: Gerente              |
+---------------------------------+
| + constructor(...)              |
| + abrirConta(conta: ContaBancaria): void |
| + fecharConta(conta: ContaBancaria): void |
| + mudarTipoConta(conta: ContaBancaria, novoTipo: string): void |
+---------------------------------+
              |
              |
     +--------+---------+
     |                  |
+----v----+      +------v------+
| Conta   |      | ContaCorrente|
+---------+      +-------------+
| # saldo |      | # chequeEspecial: number
+---------+      +-------------+
| depositar(valor: number): void |
| sacar(valor: number): void     |
| verificarSaldo(): number       |
| transferir(destino: ContaBancaria, valor: number): void |
+-----------------+
        ^
        |
+-------+-------+
|               |
| ContaPoupanca |
+---------------+
| # taxaJuros: number
+---------------+
| calcularTaxa(): number |
| transferir(destino: ContaBancaria, valor: number): void |
+---------------+

+-----------------------+
|        Gerente        |
+-----------------------+
| - nomeCompleto: string|
| - id: string          |
| - clientes: Cliente[] |
+-----------------------+
| + constructor(...)    |
| + adicionarCliente(cliente: Cliente): void |
| + removerCliente(cliente: Cliente): void |
| + abrirConta(cliente: Cliente, tipoConta: string): void |
| + fecharConta(cliente: Cliente, conta: ContaBancaria): void |
| + mudarTipoConta(cliente: Cliente, conta: ContaBancaria, novoTipo: string): void |
+-----------------------+

Criar documentação do projeto

Melhorar gestão de erros da API