Project Information

Introduction

For you who want to contribute, here are some basic information about the project requirements, dependencies and build command.

Requirements

Because it acts on a specific layer of the architecture of a Java Project, the HappyTree API has a very limited list of requirements, so, in addition to being easy to use, the HappyTree API almost has not requirements.

To use the HappyTree API as project dependency, you just need of Java 8.

To contribute for the HappyTree API, the requirements are:

• Java 8;
• Maven 3.6.x;
• The Java and Maven environment variables must be well configured ($JAVA_HOME, $MAVEN_HOME and $PATH).
• SonarLint: It is optional, but highly recommended to fix code issues.

For a code contribution to be successful, it has to pass the following steps:

1. Coding Standards;
2. Unity Tests;
3. Sonar Analysis.

Dependencies

The HappyTree API has two dependencies:

• JUnit 4.13.1 for unit tests;
• Jackson 2.17.2 for conversions from Java objects.

Code structure

HappyTree API is structured into different directories:

• src/main: API code.
• src/test: JUnit test code.

Build

For building, go to the project root folder and enter the following command:

mvn clean package -Dgpg.skip=true