Jodd Code

Jodd is hosted on GitHub:

The Jodd's source code is released under the BSD license.

Get the Code

You can get the code by clonning Jodd Git repository:

git clone jodd

Build Instructions

Jodd is built with Gradle targeting Java 1.8. You don't have to install anything, the only prerequisites are Git and Java JDK.

After cloning Jodd repo, you can build the project with:

gradlew build

This will build all jars and run all unit tests. To skip the tests (for faster build), execute:

gradlew build -x test

To generate full release, including running integration tests and generating various reports:

gradlew release

And that's all!

Running Integration Tests

Integration tests are executed only when building release task or testAll task.

For integration tests you will need also to set up databases named: 'jodd-test' on local MySql (access: root/root!) and PostgreSQL (postgres/root!). The easiest way to run the test infrastructure is by using Docker.

Using Java IDE

Since Jodd is a Gradle project, you can easily open it by selecting main build.gradle in every modern Java IDE (IntelliJ IDEA, Eclipse, Netbeans).

IntellJ IDEA

IntelliJ IDEA can open Jodd project very nicely. Just follow the simple steps:

1) Install Gradle

You must first install the Gradle: simply download the distribution archive and unpack it somewhere. Then enable IntelliJ IDEA Gradle plugin and set the path to the Gradle installation.

2) Open project

open project

3) Wait until Gradle project is build

build source

4) Import Gradle project

import project

Jodd uses JDK8. Thats all!


Eclipse users also should change the "Deprecated and restricted API" setting, to log "Forbidden references" as Warnings (and not Errors). We have some test cases that uses restricted API - don't worry, it's only used in the tests!

This Eclipse option is located here: Windows > Preferences > Java > Compiler > Errors/Warnings or (Project) Properties > Java Compiler > Error/Warnings.


Feel free to contribute! We accept patches, diffs and pure sources :)

The best way to contribute would be via GitHub, using the following workflow:

  • fork Jodd repo (upstream) to your GitHub account (origin)
  • clone origin to local repo
  • make branch for your work, commit often
  • push local branch to origin
  • when the work is done, send us pull request (PR)