Downloading the source code

The best way to start developing Qcadoo is to checkout the latest stable branch (coming soon) from our git repository or the the developers snapshot if you want to be more on the cutting edge of our work.

Our git repositories are available at GitHub: https://github.com/qcadoo

You can download an archive with the full source code with your browser or you can clone the repository using git which will help you with version control.

To clone the repository you must first install git on you computer. On Linux systems you can do this by finding git in your standard package manager.

For example on Debian based systems the command:

sudo apt-get install git-core

does the trick.

For Windows and Mac OS please download the appropriate installable on: http://git-scm.com/download

After git has bean installed check if it has bean configured in your system. To do this open a command line and type

git --version

This should output the git version info. If not you might need to set your PATH variable to git's folder with its executable's.

Now we can create a folder for Qcadoo's sources like qcadoo-src for example. 

Enter that folder in you command line and type:

git clone git://github.com/qcadoo/qcadoo-maven-plugin.git

This should create a qcadoo-src/qcadoo-maven-plugin folder with the Qcadoo Maven Plugin.

Afterwards type:

git clone git://github.com/qcadoo/qcadoo.git

This should create a qcadoo-src/qcadoo folder with the Qcadoo Framework.

And at last type in the command line:

git clone git://github.com/qcadoo/mes.git

This should create a qcadoo-src/mes folder with the Qcadoo MES modules.

Building the source

Before building the sources you will have to install maven on your computer. On Linux systems you should be able to find maven in you default package manager. On Debian based systems for example typing this in the command line:

sudo apt-get install maven2

should do the trick.
For Windows and Mac OS systems please download the binary zip archive on: http://maven.apache.org/download.html
and follow the installation instructions on that page.

To double check if maven is correctly installed open a command line and type:

mvn -version

If it outputs its version info then we can proceed to compile and test the sources.

In your command line go to qcadoo-src/qcadoo-maven-plugin directoryand type:

mvn clean install

do the same in the qcadoo-src/qcadoo directory. If they do, type: 

mvn clean install

instead.

Afterwards in the qcadoo-src/mes directory type:

mvn clean install -Ptomcat -Dprofile=tomcat

This may take quite a while as out current build process has a lot of maven plugins which will be downloaded at first. On a clean OS install even up to 30 min depending on your Internet connection.

When the process finishes you have to see in the last few lines if it was successful. If you see:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------

then your build is OK. But if instead you'll get the following message on this step

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD FAILURE
[INFO] ------------------------------------------------------------------------

then the issue tracker is your friend :o) File a bug report with detail information about your system on: http://issues.qcadoo.org/