Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
98 lines (79 sloc) 3.15 KB

Source code

We use Git as source control management.

The blessed OptaPlanner repositories, summarized below, are hosted on GitHub.

optaplanner

The source code for OptaPlanner itself, examples and documentation.

  1. Get the source code locally with Git:

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

    If you don’t have a GitHub account or your local Git installation isn’t configured with it, use this command instead, to avoid an authentication issue:

     $ git clone https://github.com/kiegroup/optaplanner.git optaplanner
     ...
  2. Build it with Maven:

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

    The first time, Maven might take a lot 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 NetBeans).

    Developed withIntelliJ IDEA
  5. Optional: Use a Java profiler (such as JProfiler or VisualVM).

    JProfiler
  6. Optional: Write some documentation in AsciiDoc.

optaplanner-wb

The source code for OptaPlanner Workbench.

optaplanner-website

The source code for this website and presentations.

  1. Get the source code locally with Git:

     $ git clone git@github.com:kiegroup/optaplanner-website.git
     ...
  2. Build it with Awestruct:

     $ cd optaplanner-website
     $ ./build.sh clean build
     ...
  3. Show it in a browser:

     $ firefox _site/index.html
     ...
  4. Edit the AsciiDoc sources.

Contribute

Want to improve our sources? 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.