Where to start depends on what your use is for

I had always hoped that the following may apply

  • Learn many features of the frameworks used
  • Using it as a base for your own customized use
  • Being able to use it off the shelf

If you intend to use it or even just to see it in action you will need to do the following

  • Download Maven from http://maven.apache.org/maven2/
  • Unzip Maven to a folder of your choice
  • Add the maven install/bin to your path
  • Unzip the CRUD app

    What you do next depends...

Want to see it in your favourite editor?

Run mvn idea:idea or mvn eclipse:eclipse

Configure and run it?

Load crud-data\src\main\config\cayenne.xml into the Cayenne modeller and change your DB settings

Edit the Maven Project Object Model file: crud-data\pom.xml add a new dependancy for your JDBC driver. SQL Server is included:

    <dependency>
        <groupId>jtds</groupId>
        <artifactId>jtds</artifactId>
        <version>1.1</version>
    </dependency>

Note: You may need to add the jar for your driver manually if it isn't on the public maven repository on http://www.ibiblio.org/maven/ There are example scripts (batch files, sorry *nix users) that add a jar to your local Maven repository in the maven-scripts folder.

Edit your Maven settings.xml, there is a sample file in the project root folder. Setup the rights to deploy to your local Tomcat.

Edit the pom.xml in the project root Check the tomcat.manager.url is set to the correct location

Next step is optional:

It is recommended that Maven can be configured to use a local copy of a remote repository instead of each user having to download from the ibiblio server. Here is one way...

  • If you have a shared Tomcat (eg on a development server) startup the "webdav" webapp that comes with Tomcat.
  • • Copy files from your local repository to the webdav repository. Windows XP users can do this with win explorer. Note: You need to have downloaded all artifacts from ibiblio or its mirrors first.

    Edit the pom.xml section to set the path to the webdav maven repos

        <repositories>
            <repository>
                <id>local</id>
                <url>http://sharedtomcat:8080/webdav/maven2</url>

    There are other ways to achieve this in the Maven documentation.

Run mvn install to build, test and deploy the application. Note: running Maven the first time will automatically download all dependancies, this will take a few minutes.