/template-java-spring-microservice

Template created by pagoPa Tech

Primary LanguageJava

Template for Java Spring Microservice project

Quality Gate Status

TODO: add a description

TODO: generate a index with this tool: https://ecotrust-canada.github.io/markdown-toc/

TODO: resolve all the TODOs in this template

Api Documentation 📖

See the [OpenApi 3 here.](TODO: set your url)

Technology Stack

  • Java 11
  • Spring Boot
  • Spring Web
  • Hibernate
  • JPA
  • ...
  • TODO

Start Project Locally 🚀

Prerequisites

  • docker

Run docker container

from ./docker directory

sh ./run_docker.sh dev

ℹ️ Note: for PagoPa ACR is required the login az acr login -n <acr-name>

Develop Locally 💻

Prerequisites

  • git
  • maven
  • jdk-11

Run the project

Start the springboot application with this command:

mvn spring-boot:run -Dspring-boot.run.profiles=local

Spring Profiles

  • local: to develop locally.
  • default (no profile set): The application gets the properties from the environment (for Azure).

Testing 🧪

Unit testing

To run the Junit tests:

mvn clean verify

Integration testing

From ./integration-test/src

  1. yarn install
  2. yarn test

Performance testing

install k6 and then from ./performance-test/src

  1. k6 run --env VARS=local.environment.json --env TEST_TYPE=./test-types/load.json main_scenario.js

Contributors 👥

Made with ❤️ by PagoPa S.p.A.

Mainteiners

See CODEOWNERS file