Setting up maxodiff

MaxoDiff can be run from the command-line or as a Web application.

Prerequisites

maxodiff is a Java application. If you want to build maxodiff from source, then the build process described below requires Git and Java Development Kit (JDK) 21 or newer.

Installing maxodiff

Building from sources

To build maxodiff from sources, go the GitHub page of maxodiff, and clone or download the project, then build the executable JAR files from sources with Maven:

  git clone https://github.com/P2GX/maxodiff.git
  cd maxodiff
  ./mvnw clean package

We use the Maven Wrapper for building the sources, so installation of Maven prior to build is not required.

Download resources

We can download the resource files needed by maxodiff by running the download command of the CLI JAR:

java -jar maxodiff-cli/target/maxodiff-cli.jar download

The command will download the data files into data folder that will be created in the current working directory. See the command's documentation for more options.

Start Maxodiff web app

The web app can be started as:

java -jar maxodiff-html/target/maxodiff-html.jar

By default, the app will serve requests at http://localhost:8080.