This guide details how you can build this repository locally in order to run the examples, inspect the code or to contribute back improvements and fixes.
You need to install the following in order to be able to build this project:
- Git - as you are already a GitHub user, you probably already have this setup. If not, please consult the GitHub Getting Started Guide. It is assumed that you cloned the project to a local directory.
- Java 11 - You can obtain Java 11 from Adopt OpenJDK. Alternatively, an excellent production distribution is also maintained by Amazon - Corretto 11
- Apache Maven - Obtain the latest version of Apache Maven from https://maven.apache.org/
This project makes use of the TeraHelix Spear binaries.
You need to obtain a 'terahelix-licensee' token (used in the configuration below) in order to get access to these binaries. Please contact admin@terahelix.io to obtain your token.
Once you have installed Apache Maven, you need to configure its settings.xml
file such that your environment is able to resolve the TeraHelix Spear binaries that is required for the build.
In particular, you need to update the repositories
, pluginRepositories
and servers
section of the settings.xml
file.
You can either use this projects version in its entirety - .github/workflows/settings.xml - or simply just as an example of what to update your settings.xml
file to if you want to preserve other modifications.
However, please ensure that you replace this section:
<password>${env.TOKEN_PACKAGE_READ_WRITE_DELETE}</password>
with
<password>##YourToken##</password>
Where ##YourToken##
is the token you obtain by contacting admin@terahelix.io.
It is important that your environment is configured to have the JAVA_HOME
environment variable configured to point to your installation of the JDK. Otherwise you might experience some of the compilation problems described in this article : https://www.baeldung.com/maven-java-home-jdk-jre
For instructions on how to configure your JAVA_HOME
environment variable, please refer to the following resources:
- AdoptJDK Installation Guide : https://adoptopenjdk.net/installation.html
- Amazon Corretto Installation Guide : https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/what-is-corretto-11.html
You are now ready to build the project. You can do a full build by executing the following command :
mvn clean install
Or if you prefer, you can do so without executing the tests:
mvn clean install -DskipTests=true