Quickstart Setting up project sources

This quickstart gets the Citrus project sources running in a few minutes, starting with initial git repository clone and ending with a built Citrus project ready for coding.


Initial git clone

First of all we get the Citrus sources from the repository on GitHub (http://www.github.com/). You can use the following command to do this

git clone git://github.com/christophd/citrus.git

This will clone the Citrus project to the target directory citrus. In the following this project directory is referred to as PROJECT_HOME. For detailed instructions about the version control system git, please consult the official website http://git-scm.com/.

Build the Citrus artifacts

Now everything is setup properly and you can use Maven for all the rest. Call

mvn install

This command runs the full Maven build lifecycle with compilation, testing, packaging and installation of all artifacts. You will find the freshly built Citrus JAR files in your local Maven repository. Using this new own Citrus version is quite simple. Just add the SNAPSHot dependency to your projects POM like this


Create IDE project files

You can easily create the project files for your favorite IDE. For IntelliJ IDEA, in PROJECT_HOME call

mvn idea:idea

for Eclipse, call

mvn eclipse:eclipse

for Netbeans call

mvn netbeans:netbeans

The project files are now ready for import in your IDE. This is the preferred way for creating IDE project files in Maven. Please do not create IDE projects manually. Maven takes care of the whole project classpath construction.

Make sure that you have set the M2_REPO classpath variable set in Eclipse (or Netbeans). The variable value points to your local Maven repository (typically found in C:\Documents and Settings\username\.m2\repo or ~/.m2/repo).

Maven ofers a suitable command to do this automatically:

mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo 

What's next?

Have fun with Citrus!