Development

Setup

Windows

As the Gradle task busterTest does not work under Windows, we recommend that contributors using Windows install Ubuntu on a virtual machine and use the instructions below. Furthermore, Windows users will need to have Git installed on their machines in order to build the Topsoil project.

Ubuntu

Install Java 8 with NetBeans

Go here to download, then follow the installation instructions.

Install Node.js

Execute this install script to install Node.js so that it is compatible with Gradle.

Install PhantomJS and Buster.JS

Execute this command in a terminal:

npm install -g buster phantomjs

Gradle

Gradle wrapper

The most reliable way to execute the build script is to use the Gradle wrapper (e.g., ./gradlew build).

System install

As the Ubuntu repos contain an outdated version of Gradle, you must add a PPA and install as follows:

sudo add-apt-repository ppa:cwchien/gradle
sudo apt-get update
sudo apt-get install gradle

Fork and clone Topsoil

Click here to automatically fork Topsoil.

Then, execute the following commands in a terminal to clone your new fork:

git clone https://github.com/YOUR_USERNAME/Topsoil
cd Topsoil

Verify your setup

Execute the following command in a terminal:

gradle check busterTest

If the command runs without errors, you should be set up correctly.