Developer Guide: Preparing the environment

Dependencies

Ensure you have installed and configured the following tools:

• Java 8 JDK (OpenJDK, Oracle Java SE JDK)
• GIT
• Docker

Ensure the following commands execute successfully:

java -version
git --version
docker ps
docker-compose version
docker-machine ls

A Docker engine is required to host the services used. Please refer to Docker sections of the Developer Guide for help in installing and using Docker.

All Docker and Gradle commands must be executed in the project root directory.

Importing the project in an IDE

IntelliJ IDEA

• Create a New Project From Existing Sources and import as a Gradle project
• Note that IntelliJ might time out if a background Gradle process (for example, running the GWT compiler server) blocks the Gradle import. Stop and start the background process to unblock.

The log messages of the running application can be colour-highlighted with the GrepConsole plugin and our configuration.

Eclipse

• Run ./gradlew eclipse
• In Eclipse go to File > Import and import the project as Existing Projects into Workspace

The working directory in your IDE must always be set to the project root directory. We recommend you set this as the default directory in your IDE for all Run Configurations.