easy-rules/site/about/getting-started.md

layout	title	header	prev_section	next_section	doc
docs	Getting started	Getting started	about/overview	user-guide/introduction	true

Easy Rules is a Java library. It requires a Java 1.5+ 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 :

{% highlight bash %} $ git clone https://github.com/benas/easy-rules.git $ cd easy-rules $ mvn package {% endhighlight %}

Easy Rules core jar easyrules-core-{{site.version}}.jar will be generated in the target folder.

Use with maven

Easy Rules is a single jar file with no dependencies. You have to add the jar easyrules-core-{{site.version}}.jar to your application's classpath.

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

<dependency>
    <groupId>org.easyrules</groupId>
    <artifactId>easyrules-core</artifactId>
    <version>{{site.version}}</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.easyrules \
    -DarchetypeArtifactId=easyrules-archetype \
    -DarchetypeVersion={{ site.version }}

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:

$>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.

Finally, you can import this maven project into your favorite IDE and tweak the application to your needs.