Build status badges

Project Title

Provide an introductory paragraph, describing:

• What your project does
• Why people should consider using your project
• Link to project home page

Table of Contents

1. About the Project
2. Getting Started
   1. Dependencies
   2. Building
   3. Running Tests
   4. Installation
   5. Usage
3. Release Process
   1. Versioning
   2. Payload
4. How to Get Help

About the Project

Here you can provide more details about the project

• What features does your project provide?
• Short motivation for the project? (Don't be too long winded)
• Links to the project site

Back to top

Getting Started

This section should provide instructions for other developers on how to run the project.

Prerequisites

Any software or dependencies that should exist before attempting to run or install the project.

Building

Instructions for how to build your project, any build targets

mvn clean install
# to generate the site and reports
mvn site install -P reporting
# Start the server
mvn clean spring-boot:run

Running Tests

Describe how to run unit tests for your project.

mvn clean test

Other Tests

If you have formatting checks, coding style checks, or static analysis tests that must pass before changes will be considered, add a section for those and provide instructions

Installation

Instructions for how to install your project's build artifacts

Examples should be included

Usage

Instructions for using your project. Ways to run the program, how to include it in another project, etc.

Examples should be included

If your project provides an API, either provide details for usage in this document or link to the appropriate API reference documents

Back to top

Versioning

How to create releases

Payload

Back to top

How to Get Help

Provide any instructions on how to get help.