GanttProject Developer Guide
This page provides instruction for building GanttProject 2.8 or GanttProject HEAD from the source code.
The instructions assume that you’re using Ubuntu-based Linux distribution. The process on other distros and Windows/Mac OSX should be similar, modulo differences in packages/paths and the way command line terminal works.
A bare minimum which you need is:
Java SE Development Kit(JDK) version 8 from Oracle or OpenJDK. You also need JavaFX It is bundled with Oracle’s JDK, but if you’re using OpenJDK then you need to install JavaFX separately. It is available as
openjfxin Ubuntu repositories.
Git version control to checkout the sources.
Please make sure that you can run
Checking out the sources
The source code is stored in GitHub repository. You can clone the repository using
git clone https://github.com/bardsoftware/ganttproject.git
We also publish self-sufficient archives with the sources of the stable versions. The latest published is GanttProject 2.8.2
The rest of this page assumes that you checked out the sources using one of the ways into
GanttProject 2.8 code sits in a branch named
Having cloned the repository, you can switch to that branch with
git checkout BRANCH_2_8_X.
Building with Gradle
If everything is OK with your environment then the following will build a binary distribution of GanttProject:
cd /tmp/ganttproject/ganttproject-builder gradle distBin
The distribution is assembled in
ganttproject-builder/dist-bin directory. You can
run GanttProject using
cd /tmp/ganttproject/ganttproject-builder/dist-bin ./ganttproject
You can also start GanttProject using
gradle runApp which will build a distro and launch
GanttProject as necessary.
Basically, that’s everything that you need to be able to change the sources using any text editor, build and run the changed code.
Building and running from IntelliJ IDEA
The instructions below apply to IntelliJ IDEA but other popular IDEs can also be used in a similar way.
IDEA supports Gradle out of the box.
You can just import GanttProject with
File.New.Project from Existing Sources menu action in IDEA
where you need to choose
ganttproject-builder/build.gradle file. When asked about the modules,
.. as shown on the screenshot below
Having completed the import, you can run GanttProject using Gradle’s runApp task. Open Gradle
pane in IDEA, find task
right-click and choose
Building and running from Eclipse
The instructions below were tested with the latest Eclipse 4.6.2 aka Neon.2 and assume that Gradle integration is set up properly (e.g. you have set paths to your local Gradle distribution) Your mileage may vary.
Generate Eclipse projects using
gradle eclipsecommand executed in
ganttproject-builder. It generates
.projectand other files in each project’s directory.
Use import wizard
Importmenu in Eclipse to import the generated projects into the workspace.
Choose the root folder
Search for nested projects. Uncheck the root project
You may need to ignore JavaFX API restriction for
When import is completed and all projects have been built successfully, you can run GanttProject using Gradle’s runApp task wrapped into Eclipse run configuration.
In the run configurations dialog choose Gradle and click New configuration button.
runAppas task name,
ganttproject-builderas working dir.
Debugging from Eclipse
To be able to debug GanttProject you need to start it in debug mode and attach to the debug port from Eclipse
ganttproject-builderfolder. Java Machine will start and immediately stop waiting until debugger attaches to port 9009
Create new Debug Configuration in Eclipse (e.g. by right-clicking
Debug As). Specify port
9009and optionally check
Now when you run this debug configuration, Eclipse will try to connect to port localhost:9009 and GanttProject which is waiting the connection will resume.
You may want to add some sources to the debug configuration so that Eclipse could map info from the debugged application to the source code.