gricar/ngcash-financial-bank

API que permite realizar transferências bancárias internas entre os clientes da NG.CASH

Bem-vindo a API de contratos de serviços financeiros da NG.CASH !

Descrição

É uma aplicação que possibilita que usuários da NG consigam realizar transferências bancárias internas entre si.

Principais funcionalidades ✨

As principais responsabilidade desta API estão relacionadas a integração com o banco de dados, seguindo os princípios do REST, com as requisições feitas baseados nos endpoints:

Caminho	Responsabilidade
/login	Realizar login na aplicação para gerar o token de autenticação
/users	Listar todos clientes cadastrados na aplicação
/users/:id	Listar o cliente e seu saldo disponível na conta
/users/register	Cadastrar novo cliente
/profile	Listar o cliente e seu saldo disponível na conta baseado no id do token JWT
/profile/money-transfer	Efetuar a transferência de dinheiro (cash-out) para outro cliente NG
/profile/transactions	Listar todas transferências de dinheiro do cliente logado (cash-out e cash-in)

Tecnologias utilizadas 👨‍💻

• TypeScript
• Node.js
• Express
• Docker
• Typeorm
• PostgreSQL
• ESLint

Executando o projeto 🌐

• É necessário ter o Docker e o Docker Compose instalado em sua máquina.

• Clone o projeto: git clone git@github.com:gricar/ngcash-financial-bank.git.

• Entre na pasta do projeto: cd ngcash-financial-bank/app.

• Execute o script no terminal para iniciar o Docker Compose: docker-compose up -d --build.

• Entre na pasta do projeto: cd backend.

• Instale as dependências: npm install.

• Os contêineres estarão prontos e você poderá acessar o projeto em: http://localhost:3999

• Para desligar os containers, utilize o script: docker-compose down