Build and run - nuanxed/MateCat-Filters GitHub Wiki

To build this project you need Java 8 and Maven.

For the 2.0.0 Zombie release the commit hash version of Okapi is not used. The official v36 artefacts are used. Seems to work...

Steps to run:

Install: $ cd MateCat-Filters/filters $ mvn clean package -DskipTests

If running in IDE: Make sure a config.properties is placed "target/classes".

Run jar (preferably Docker instead see base Readme): $ cd target $ cp ../src/main/resources/config.sample.properties config.properties $ java -cp ".:filters-[YOUR_VERSION].jar" com.matecat.converter.Main

Below is legacy:


To build this project you need Java 8 and Maven.

First go into the pom.xml file, find the <okapi.commit> tag and copy the hash contained. Now you have to install the Okapi code in your local Maven repository. Pay attention to check out to the commit copied before.

$ git clone https://bitbucket.org/okapiframework/okapi.git
$ cd okapi/
$ git checkout <okapi.commit>
$ mvn clean install -DskipTests

Then:

$ git clone https://github.com/matecat/MateCat-Filters.git
$ cd MateCat-Filters/filters
$ mvn clean package -DskipTests

With instructions above you have built the filters-1.2.3.jar in the filters/target folder. To run it just type:

$ cd target
$ cp ../src/main/resources/config.sample.properties config.properties
$ java -cp ".:filters-1.2.3.jar" com.matecat.converter.Main

Note: You should use ".;filters-1.2.3.jar" (notice the semicolon) if you are on Windows.

Give a look to the default configuration in the config.properties file and adapt it to your needs.

Optional: you need the MateCat Win Converter to handle legacy Microsoft Office formats, PDFs and scanned documents. In the configuration file you can specify the location of the running instance or disable it.

While the MateCat Filters server is running navigate with your browser to http://localhost:8732 (match the port number with the one in config.properties) to use a handy interface to manually convert files.