getting started

Prerequisite

Easy Rules is a Java library. It requires a Java 1.7+ runtime.

Building from source

To build Easy Rules from sources, you need to have git and maven installed and set up.

Please follow these instructions :

$ git clone https://github.com/j-easy/easy-rules.git
$ cd easy-rules
$ mvn install

Use with maven

Easy Rules is a single jar file with no dependencies. You have to add the jar easy-rules-core-3.0.0-SNAPSHOT.jar to your application's classpath.

If you use maven, add the following dependency to your pom.xml :

<dependency>
    <groupId>org.jeasy</groupId>
    <artifactId>easy-rules-core</artifactId>
    <version>3.0.0-SNAPSHOT</version>
</dependency>

Quick start archetype

The quick start archetype generates a skeleton project with the right dependency to Easy Rules. In order to generate a quick start project, just run the following command:

$>mvn archetype:generate \
    -DarchetypeGroupId=org.jeasy \
    -DarchetypeArtifactId=easy-rules-archetype \
    -DarchetypeVersion=3.0.0-SNAPSHOT

You will be asked for your project's groupId, artifactId, version and base package. Once finished, you will get a fully functional sample application that you can run with the following command:

&>cd ${artifactId}
$>mvn compile exec:java -Dexec.mainClass=${your.base.package}.Launcher

where ${your.base.package} is the value of the base package you were asked for when creating the project.