Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 1.45 KB

README.md

File metadata and controls

49 lines (40 loc) · 1.45 KB

TIS Microservice Template

About

This is a template to be used for TIS microservices with the following technology:

  • Java 17
  • Spring Boot
  • Gradle
  • JUnit 5

Boilerplate code is to be generated with:

  • Lombok
  • MapStruct

Code quality checking and enforcement is done with the following tools:

  • EditorConfig
  • Checkstyle
  • JaCoCo
  • SonarQube

Error and exception logging is done using Sentry.

TODO

To use this template, create a new repository from it and follow the TODOs in the code, with the following additional changes.

  • Update copyright year in LICENSE.
  • Update copyright year in TemplateApplication.
  • Update copyright year in TemplateApplicationTest.
  • Update this README.
  • Sentry:
    • Set up Sentry project.
    • Provide SENTRY_DSN and SENTRY_ENVIRONMENT as environmental variables during deployment.
  • Sonar:
    • Add repository to SonarCloud.
    • Add SonarCloud API key to repository secrets.
  • Update Dependabot configuration to remove unneeded teams.
  • Update the references to tis-template and port number in task-definition.

Versioning

This project uses Semantic Versioning.

License

This project is license under The MIT License (MIT).