Project description goes here. It should give us a general idea of the main goals of the project (what problem aims to solve?).
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to run the project and how to install them
For example
- Maven 3
- NodeJS 16.X
| Variable | Description | Required? |
|---|---|---|
| VAR_NAME | description | If not, please especify the default value |
A step by step guide to get your development environment running.
Always write a explanation of each step as shown below.
- Build the project
mvn clean install
- Run the project
java -jar target/*.jar
Explain how to run the automated tests for this system
Add additional notes about how to deploy this on all environments.
See full docs.