This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Building from Source

How to set up your environment to build and test Jikkou itself.

    This guide is for contributors who want to build and test the Jikkou project itself. If you are looking to develop your own Jikkou extensions or use the Java API, see the Developer Guide instead.

    Prerequisites

    Building Jikkou

    We use Maven Wrapper to build our project. The simplest way to get started is:

    For building distribution files.

    $ ./mvnw clean package -Pdist -DskipTests

    Alternatively, we also use Make to package and build the Docker image for Jikkou:

    $ make

    Running tests

    For running all tests and checks:

    $ ./mvnw clean verify

    Code Format

    This project uses the Maven plugin Spotless to format all Java classes and to apply some code quality checks.

    Bugs & Security

    This project uses the Maven plugin SpotBugs and FindSecBugs to run some static analysis to look for bugs in Java code.

    Reported bugs can be analysed using SpotBugs GUI:

    $ ./mvnw spotbugs:gui