Getting Started As Developer

[idhamari]

Build ARX Source-code using Eclipse

Check this video tutorial.

1. Preparing your github repository
   • Fork the ARX repository
   • Clone your forked repository.
   • Create new branch for your development
2. Preparing your IDE
   • Install eclipse for jave
   • Create a new java project as follows:
     • File> New
       
     • Un-check the default location
       
     • Browse to your ARX cloned repository then click the "Finish" button
       
   • Remove libraries for other systems e.g. if you are in windows, remove libs for Linux and mac
     • todo (screenshots)
3. Building and running ARX
   • Test first example and GUI
   • Read the doc
4. Start contribution:
   • Add arx formatter to eclipse, this helps unifying the code styling and make the code more readable and easy to understand:
     • Download and extract the file inside the zip file in the link above.
     • In eclipse, select Window > Preferences
       
     • Select Java>Code Style > Formatter then click on the Import button
       
     • Open the extracted downloaded XML file
       
   • Click on Apply and Close
     

• Before start contribution, please read this and this.

Debugging

Debugging should be similar to other java applications, this is a good tutorial about debugging in eclipse.

[prasser]

Most libraries will be on the classpath twice. In addition to removing all libraries for the wrong system, also all libraries that are not located in ./lib/ant must be removed.

[prasser]

Also, modern Eclipse asks you whether you want to create a module. You must select "No".

[prasser]

A description for building with Maven (instead of ant) would also be great.

[idhamari]

Thanks for your feedback. I will consider this in the next video tutorial.

[idhamari]

A description for building with Maven (instead of ant) would also be great.

@prasser
I tried to build ARX using a recent version of maven i.e. 3.8.4 e.g. mvn compile but I got errors related to swt e.g.:

  [ERROR] /home/ibr/Downloads/arx-master/src/gui/org/deidentifier/arx/gui/view/impl/menu/DialogComboSelection.java:[26,23] package org.eclipse.swt does not exist

I was able to build ARX API without problem using

          mvn compile -Dcore=true 

This is the complete error output

[idhamari]

I solved the problem above by adding the library manually using eclipse interface. I got another error related to the library we updated last time i.e. de.linearbits.preferences.PreferenceBoolean

Please correct me @prasser if I am wrong, I think the maven file should be updated as well.