• You are looking at the developer documentation for the most recent public release of RepoSense. The version matching the latest master branch is here.

    Setting up


    • JDK 1.8.0_60 or later (download ).

    • npm 6.0 or later (download ).

    • git 2.14 or later (download ).

      Type git --version on your OS terminal and ensure that you have the correct version of git.

    Getting the code

    1. Fork the reposense/reposense repo.
    2. clone the fork to your computer.

    Setting up the IDE

    The recommended IDE is Intellij IDEA. While it is not compulsory to use it, note that we will not be able to help you troubleshoot IDE problems if you use any other IDE.

    1. Ensure you have configured IDEA for the correct JDK, as explained in this tutorial.
    2. Import the project as a Gradle project, as explained in this tutorial.

    Verifying the setup

    This project is already configured to use Gradle for build automation. If you are new to Gradle, see this tutorial to learn how to use it.

    1. Open a command prompt and navigate to the project root.
    2. Run gradlew clean build (./gradlew clean build if you on a Unix-like OS), and ensure that it finishes with a BUILD SUCCESSFUL message.
    3. Run the tests using the gradlew test systemtest command and ensure it succeeds too.
    4. You can also try running the app using code, as given in the panel below.
    • To run the app from code, run gradlew run from the project root. By default, it will run based on the config files in the [project root]/config folder.
    • To supply flags, you can use the -Dargs="[FLAGS]" format.
      e.g., gradlew run -Dargs="--since 31/12/2019 --formats java adoc xml"

    Before you start coding

    ... read the Workflow section.