desafio-tecnico-xp

• Sobre o projeto
• Funcionalidades
• Tecnologias utilizadas
• Tomadas de decisão
• Desafios enfrentados
• Endpoints da aplicação
• Como rodar a aplicação

Este projeto contém apenas o Backend da aplicação. Onde simula um aplicativo de investimento em ações, com algumas funcionalidades de conta digital.

• Comprar ou vender ativos
• Sacar ou depositar dinheiro
• Registrar cliente
• Realizar login
• Consultar a lista de ativos disponíveis para a compra
• Consultar o saldo da conta
• Cliente consegue ver quais ativos estão em sua conta

• TypeScript

• NodeJS

• Express

• Jest

• PostgreSQL

• Prisma ORM

• Docker

Durante o planejamento do projeto, escolhi utilizar NodeJS com TypeScript para dar segurança ao desenvolver o código por causa das tipagens. O banco de dados inicial foi utilizado o MySQL e posteriormente foi migrado para PostgreSQL para tentar realizar o deploy da aplicação, sem sucesso até o momento. Comecei usando Sequelize como ORM e decidi alterar para o Prisma ORM por conta de que sua documentação é detalhada e específica para TypeScript. Utilizei Jest para os testes unitários e Docker para containerizar a aplicação. A biblioteca bcrypt foi utilizada para criptografar a senha e a biblioteca JWT para fazer autenticação. O projeto está com a arquiterura MSC(Model-Service-Controller) para separar as responsabilidades de cada camada.

• Modelagem do Banco de Dados

Os momentos mais desafiadores foram implementar o Docker na aplicação, realizar os testes unitários e fazer o deploy da aplicação. O deploy foi o único desafio não superado, houve várias tentativas, mas todas sem sucesso.

Endpoints da aplicação

Método	Endpoint
POST	/conta/registrar
POST	/conta/entrar
POST	/conta/deposito
POST	/conta/saque
GET	/conta/ativos
GET	/conta/saldo
GET	/ativos
GET	/ativos/:CodAtivo
POST	/ativos/registrar
POST	/investimentos/comprar
POST	/investimentos/vender

• Node instalado
• Servidor PostgreSQL rodando

Pelo terminal, clone este repositório com o comando:

• git clone git@github.com:Douglas-marcal/desafio-tecnico-xp.git

Entre no diretório desafio-tecnico-xp e logo em seguida no diretório backend:

• cd desafio-tecnico-xp/backend

Instale as dependências:

• npm install

Para subir a tabela e popular alguns ativos pré-definidos no banco de dados:

• npx prisma migrate dev

Para subir um servidor Node:

• npm run dev

• Docker
• Docker Compose

Pelo terminal, clone este repositório com o comando:

• git clone git@github.com:Douglas-marcal/desafio-tecnico-xp.git

Entre no diretório desafio-tecnico-xp e logo em seguida no diretório backend:

• cd desafio-tecnico-xp/backend

Suba o container com o comando:

• docker-compose up -d

Acesse o terminal do container com o comando:

• docker exec -it desafio_tecnico_xp bash

Dentro do container, instale as dependências:

• npm install

Para subir a tabela e popular alguns ativos pré-definidos no banco de dados:

• npx prisma migrate dev

Para subir um servidor Node:

• npm run dev

Para rodar os testes unitários utilize o comando:

• npm test

Com o servidor rodando, para usar a aplicação você precisará do Insomnia ou Postman para fazer requisições HTTP

Neste exemplo a porta 3333 será utilizada

Para registrar um cliente utilize o Endpoint POST /conta/registrar

• É necessário enviar um JSON no formato:

Para realizar o login utilize o Endpoint POST /conta/entrar

Para fazer o login é necessário informar o email e senha cadastrados no Endpoint de registro.

• É necessário enviar um JSON no formato:

:warning: Para realizar as próximas requisições será preciso informar o token recebido no Endpoint de login para fazer a autenticação.

Pré-requisito para as próximas requisições:

• Adicionar no header a chave Authorization com o valor do token recebido ao efetuar o login

Para realizar um depósito utilize o Endpoint POST /conta/deposito

• É necessário enviar um JSON no formato:

Para realizar um saque utilize o Endpoint POST /conta/saque

• É necessário enviar um JSON no formato:

Para consultar o saldo da conta utilize o Endpoint GET /conta/saldo

Para consultar todos os ativos que o cliente possui utilize o Endpoint GET /conta/ativos

Para consultar a lista de todos os ativos utilize o Endpoint GET /ativos

Para consultar um único ativo utilize o Endpoint GET /ativos/:CodAtivo

Para registrar um novo ativo utilize o Endpoint POST /ativos/registrar

• É necessário enviar um JSON no formato:

Para comprar um ativo utilize o Endpoint POST /investimentos/comprar

• É necessário enviar um JSON no formato:

Para vender um ativo utilize o Endpoint POST /investimentos/vender

• É necessário enviar um JSON no formato: