Projeto API XP! 🚀

Boas vindas a este repositário do projeto API XP, abaixo estão compilados informações sobre o projeto, tomada de decisões, tecnologias e algumas considerações pessoais sobre o projeto.

Sobre o projeto

Este projeto simula algumas operações básicas de conta corrente como saque, depósito e consulta de saldo além de abertura de conta e encerramento. E algumas operações básicas de corretora de investimentos como consulta a ações e compra e venda ações.

⚠️ Orientações de como rodar o projeto.

Rodando aplicação no Docker ou Localmente

- Faça o clone do repositário: `git clone https://github.com/VagnerBritz/Desafio-Tecnico-XP`. - Na raiz do projeto existe um arquivo chamado `.env.example `, renomeie para `.env` e altere as credenciais desse arquivo conforme as suas credenciais.

Rodando Com Docker 🐋

• O container rodará na porta padrão (3306), pare o mysql ou então adapte no docker-compose.yml.

• Rode os serviços node e db com o comando docker-compose up -d --build.

• Esses serviços irão inicializar um container chamado projeto_xp e outro chamado projeto_xp_db;

• A partir daqui você pode rodar o container projeto_xp via CLI ou abri-lo no VS Code;

• Instale as dependências com npm install e rode a aplicação com npm start, assim a aplicação criará o banco de dados e fará o povoamente das tabelas, iniciando a aplicação.

• É possível testar a API localmente pelo swagger. Url http://localhost:3000/docs/.

Rodando localmente

• Inicie a instalação das dependências com npm install e execute o comando npm start, assim a aplicação criará o banco de dados e fará o povoamente das tabelas, iniciando a aplicação. É possível testar a API localmente pelo swagger. Url http://localhost:3000/docs/.

Tecnologias utilizadas

• NodeJs;
• Express;
• Sequelize;
• JWT - Json Web Token;
• Express async errors;
• Mysql;
• Swagger.

Tomada de decisão

Decidi fazer o teste em back end por me identificar mais com essa área. Com o desafio em mãos separei o desafio em etapas menores para poder planejar melhor como desenvolver. Decidi que seria melhor separar conta corrente de carteira de investimentos. Modelei o banco de dados conforme a figura abaixo:

Diagrama de Entidade-Relacionamento

Tabelas do banco de dados projetoXp

* `accounts` - Dados da conta e saldo;
* `users` - Dados do cliente;
* `stocks` - Dados referentes a cotação das ações (os valores estão mockados e não estão atualizados).
* `stockPortofólio` - Simula a carteira de investimentos do cliente.
* `accountTransactions` - Faz um papel de log das mvimentações da conta (corrente e investimentos);

Arquitetura MSC

A arquitetura de software apliquei observando a estrutura MSC(Model-Service-Controller) isolando as responsabilidades de cada camada. Para gerenciar o banco de dados mysql usei o ORM Sequelize. Embora ainda não habituado ao sequelize fiz questão de usá-lo para melhor entender seu funcionamento e ganhar experiência com ele. Usei a biblioteca express-async-errors que é maravilhosa para capturar os erros do código evitando ter de usar o try/Catch em cada função que possa gerar erro e quebrar a aplicação. Utilizei o JWT para criar rotas privadas além de salvar as senhas no banco de dados criptografadas com a ferramenta bcrypt.

Pontos de melhoria 🔧

Escrevi o código, num primeiro momento para que ele "funcionasse" e depois refatorar para melhorar a sintaxe e reduzir a complexidade. Durante esse processo pode ter sido esquecido algo e não sido implementado.

Uma funcionalidade, essencial e que acabou não sendo implementada é a estrutura de transactions do sequelize que reverteria uma(s) funções de gravação de tabelas do banco de dados caso houvesse algum erro. Algumas operações fazem a gravação de dados em quatro tabelas diferente bastando apenas um problema para causar uma inconsistência enorme no banco de dados. Tentei implementar esta função mas acabei não conseguindo fazer funcionar naquele momento e em função do tempo acabei não conseguindo implementar.

Outros pontos importantes de melhoria:

• Ampla cobertura de validações dos dados vindos pela requisição;
• Melhoria na nomenclatura de arquivos e variáveis para ficar mais fácil a leitura e a manutenção;
• Refatoração de código, dividindo em diversas funções menores e reutilizáveis;
• Realização de testes unitários e de integração.