hengdlkh / key-project

key-processor

Prerequisites

• Git
• Java
• Maven
• Spring Boot
• MySQL
• Docker
• SemVer
• Swagger
• K8s

Instructions

1. To run this project locally first run the docker-compose.yml file of this project, that will initiate a docker container with mysql and another docker container with adminer
2. After this, run this application
3. Access http://localhost:8089/swagger-ui/index.html for tests
4. Access http://localhost:8080/ with user root and pass 12345 for sql commands
5. There is a dockerfile for this application, you also can create an image and add to docker-compose.yml

Tests

Functional tests:

• Swagger + MySQL + Adminer;
• Account agency that begin with 5 or 6 will be considered PF, the rest will be considered PJ;

Unit tests:

• Mockito + JUnit5;
• RestAssured;

Issues

• creation using email
• creation using aleatory key
• creation using cpf
• creation using cnpj
• creation using celular
• update
• inactivation using id
• get by id
• get by type
• get by client name
• get by client last name
• get by agency
• get by account
• get by dynamic query
• swagger
• db using docker
• dockerfile for this application
• 90% of unit tests
• k8s
• actuator and prometheus
• grafana
• api documentation
• db documentation
• code documentation
• tests with rest-assured