Quick Start

Step 1: Installing Maven

Downloading and installing the latest version of Maven is the first step to start using this tool.

NOTE: It is very helpful if you understand some Maven concepts before continue with this tutorial. See General Maven Documentation for more information.

Step 2: Configuring your Maven Settings

Before start using Maven, you have to configure it in order to use the plug-ins provided by WOProject. General Maven configuration is made in a settings.xml file. This file can be found at .m2 folder in the user home (_{/.m2 on Unix systems and C:ocuments and Settingsserm2 on Windows). If this file doesn't exist yet, just create it.}

You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following snippet shows how to make this configuration:

NOTE: You can download the complete settings.xml here|. See Maven Settings Reference if you want more information about the settings.xml file.

Step 3: Installing WebObjects Libraries

Maven takes control of all your project's dependencies. To develop WebObjects applications, Maven has to reference the WebObjects jars. You have to install the WebObjects libraries into your local repository to accomplish this:

NOTE: WebObjects must be installed.  See the maven-wobootstrap-plugin documentation for more information. See Maven Introduction to Repositories if you want more information about Maven repositories.

Step 4: Creating a WebObjects Project

Archetypes are the fast way to create a new project using Maven. WOProject provides one archetype to create WebObjects Application. Execute the following command to generate a basic WebObjects project:

The maven-archetype-plugin will ask the required information to create the new project.

NOTE: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of woapplication-archetype.

Step 5: Importing the Project into Eclipse

The new project is ready to be imported into Eclipse workspace. Use the Eclipse's import wizard (File > Import...) and choose the option "Existing Projects into Workspace". Select the root directory of your new project and finish the import wizard.

After adding the project dependencies to your Eclipse build path, WOLips can build the project and you will be able to start developing and running the application.

NOTE: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration here.

Step 6: Building WebObjects Applications with Maven

Now, building your project with Maven is easy. Point to the project folder on Terminal and execute:

This goal will generate a WOA package inside the target folder of your project. It also generates two compressed packages: one for woapplication and other for the webserver resources.