Fork me on GitHub

Source code

GitHub repositories

The OptaPlanner team takes care of these repositories:

optaplanner (engine)

The source code of the OptaPlanner engine, examples and documentation.
https://github.com/kiegroup/optaplanner

To build from source:

  1. Get the source code locally with Git:

     $ git clone https://github.com/kiegroup/optaplanner.git
 ...

  2. Build it with Maven:

     $ cd optaplanner
 $ mvn clean install -DskipTests
 ...

    The first time, Maven might take a lot of time, because it needs to download jars.

  3. Run the examples:

     $ cd optaplanner-examples
 $ mvn exec:java
 ...

  4. Edit the sources in your favorite IDE (such as IntelliJ IDEA, Eclipse or VSCode).

  5. Optional: Write some documentation in AsciiDoc.

optaplanner-quickstarts

The source code for each Quick Start.
https://github.com/kiegroup/optaplanner-quickstarts

optaweb-employee-rostering

The source code for the employee rostering web application reference architecture.
https://github.com/kiegroup/optaweb-employee-rostering

optaweb-vehicle-routing

The source code for the vehicle routing web application reference architecture.
https://github.com/kiegroup/optaweb-vehicle-routing

optaplanner-website (www.optaplanner.org)

The source code for this website and the presentation slides.
https://github.com/kiegroup/optaplanner-website

To build from source:

  1. Get the source code locally with Git:

     $ git clone https://github.com/kiegroup/optaplanner-website.git
 ...

  2. Build it with Maven (which uses JBake underneath)

     $ cd optaplanner-website
 $ mvn clean generate-resources
 ...

  3. Show it in a browser:

     $ firefox target/website/index.html
 ...

  4. Edit the AsciiDoc sources.

Contribute

Want to help improve our project? GitHub Pull Requests are welcome!
If you don’t know where to start, take a look at the list of starter issues for new contributors.

If you’ve found a bug and just want to report it, please open a ticket in our issue tracker with a reproducer.

Latest release
Upcoming events
Latest blog posts
Latest videos