Developer workspace setup¶

There are 7 steps to follow, assuming that you already have Java SE 6 and Eclipse IDE for Java EE Developers installed:

1. Installing SVN and Maven
2. Checking out the project
3. Creating Eclipse projects with Maven
4. Setting up the projects in Eclipse
5. Installing Tomcat Application Server
6. Installing the JDBC driver
7. Configuring Eclipse

Installing SVN and Maven¶

The first step will be to download the SVN client as well as Maven. A Maven plugin for Eclipse is also required. This plugin can be found here: http://m2eclipse.codehaus.org/

Checking out the project¶

Once SVN has been installed, go to the console and type:

cd <your_eclipse_workspace_folder>
svn checkout http://svn.docendo.org/docendo/trunk .

This will check out all docendo modules from the subversion repository.

Creating Eclipse projects with Maven¶

A call to

mvn install

is required before creating the Eclipse projects. Once this is done, the command

mvn eclipse:eclipse

will create Eclipse project files for each docendo module.

Setting up the projects in Eclipse¶

Open Eclipse and select File > Import > General > Existing Java Projects into Workspace. Import the common, io, layout, lom, repository, usermgmt and the webapp projects. To get all required libraries and dependencies, right click each project and select Maven > Enable Dependency Management. For the webapp project it is required to set all project dependencies per hand, so that Tomcat can recognize when a resource has changed. This is done by entering the project properties and then under the Java EE Module Dependencies category by checking all dependant projects.

Installing Tomcat Application Server¶

The next step will be to download and install the Tomcat Application Server (http://tomcat.apache.org/download-60.cgi). Once this is done, Eclipse has to be configured in order to recognize the server. This can be done by either installing the Sysdeo Tomcat Plugin for Eclipse (http://www.eclipsetotale.com/tomcatPlugin.html) or by manually setting it into Eclipse under the Servers panel. The webapp project has to set as a deployable project under the Servers panel.

Installing the JDBC driver¶

Since the default configuration of docendo uses HSQLDB as backend, it does not require a DB server to be installed, however the last step would be to copy the HSQLDB driver jar into the Tomcat library folder located in $TOMCAT_HOME/lib. After downloading HSQLDB, you find the required jar file "hsqldb.jar" in the ZIP's lib folder.

Configuring Eclipse¶

Import the attached eclipse preferences file using File > Import > General > Preferences to ensure that all docendo develeopers use the same code formatting styles.