README.md

Template for Quarkus Microservice project

TODO List

• Add a description
• Generate an index with this tool: https://ecotrust-canada.github.io/markdown-toc/
• Find and solve all the TODOs in this template (e.g. in .github folder, pom.xml and so on)

---

API Documentation 📖

See the OpenAPI 3 here.

---

Technology Stack

• Java 11
• Quarkus
• other...

---

Running the infrastructure 🚀

Prerequisites

• docker
• docker-compose

Run docker container

The docker compose runs:

• ELK
  • elasticsearch
  • logstash
  • kibana
• Monitoring
  • alertmanager
  • prometheus,
  • grafana (user: admin, password: admin)
• Tracing
  • otel-collector
  • jaeger

To run locally, from the main directory, execute sh run-local-infra.sh <project-name>

From ./docker directory sh ./run_docker.sh local|dev|uat|prod

ℹ️ 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

Add integration test in .integration-test and write here how to execute them

Performance testing

Add performance test using k6 in .performance-test and write here how to execute them (e.g. 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