felipelimaa / bank

O projeto API Bank tem o objetivo de simular, de forma simples, transações bancárias. Esse projeto está sendo realizado como objeto de estudo e aprendizagem.

Projeto API Bank

O projeto API Bank tem o objetivo de simular, de forma simples, transações bancárias. Esse projeto está sendo realizado como objeto de estudo e aprendizagem.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

• OpenJDK 11 (https://adoptopenjdk.net/)
• Docker (https://docs.docker.com/engine/install/)
• Docker Compose (https://docs.docker.com/compose/install/)

Features

v1:

• Criar uma conta
• Realizar deposito
• Realizar saque
• Realizar transferência
• Permitir a listagem de transações por conta
• Criar testes de Accounts
• Criar testes de Transactions

Desenvolvimento

O projeto é executado através do Spring Boot como framework backend e banco de dados PostgreSQL para armazenamento dos dados.

Para execução do projeto, é necessário ter o banco de dados PostgreSQL instalado na máquina ou rodando em container.

Para executar o PostgreSQL como container, utilize o seguinte comando:

docker-compose up -d postgresql-server

Assim, o servidor do banco de dados rodará localmente escutando a porta 5432, com os seguintes dados de autenticação:

• usuário: bank
• senha: bank
• conexão: localhost:5432

Após o servidor do banco de dados estar em execução, abra o projeto na sua IDE desejada ou, caso deseje executar o ambiente baseado no código, execute o seguinte comando:

./gradlew bootRun

Através de uma IDE, é possível executar a classe: BankApplication.groovy

Testes

Os testes foram desenvolvidos utilizando o MockMVC e banco de dados H2 para guardar os dados em memória.

O arquivo profile utilizado para definir as configuraçõs dos testes é o application-test.yaml.

Caso queira executar os testes, utilize o seguinte comando:

./gradlew test

Execução do projeto completo (build and deploy)

O projeto contempla um arquivo docker-compose.yaml e um Dockerfile composto com o processo de build e execução do projeto (multi-stage).

Caso deseje executar o projeto completo, com a build e ambiente de execução, bem como o servidor PostgreSQL, na pasta do projeto, execute o seguinte comando:

docker-compose up -d