Development Environment

This section describes how to install tools and setup a development environment.

Audience: Technical people in the software development team, especially those who are new to the team.

---

Building

Building is done with Gradle. Each project is built with

gradlew build

The gradle build can also generate Javadoc and run unit tests.

Files created as a result of running gradle are placed in the build directory of each project. The build directory should not be added to the repository.

If a build needs files to complete its task, they can be placed in a build-resources directory.

Note: Some files related to the build process might still be placed in an ant-build directory.

Testing

Unit tests can performed by running

gradlew check

CI

Continuous building and testing is also done with Travis CI. The build status should be at the top of each project's README.md.

To facilitate continuous building, it is desired to only produce one artifact (jar) per project.

IDE support

Use the Gradle build files to import projects to your IDE.

Eclipse

Historically, IDE specific files for Eclipse were committed to the repositories. These files have been removed as they are created automatically by Eclipse when importing the project (as a Gradle project). Note that if you attempt to navigate the Git history past the point where these files were removed, you may need to re-import the project when you return to the current commit.