Quick Start - XWiki

== Outline ==

== Step 1: Installing Maven ==

Downloading and installing the latest version of [[Maven>>url:http://maven.apache.org/download||shape="rect"]] is the first step to start using this tool.

6

7

8

install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal:

sudo port install maven3

In future, to keep this up to date:

sudo port upgrade maven3

Don't forget to install maven_select:

sudo port install maven_select

**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.

34

35

== Step 2: Configuring your Maven Settings ==

36

37

Advanced users can skip this step, but it's highly recommended.

38

39

[[doc:Quick Start Maven Settings Configuration Guide]]

40

41

**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>attach:settings.xml]] and install it to ~~/.m2/settings.xml.

42

43

See [[Maven Settings Reference>>url:http://maven.apache.org/settings.html||shape="rect"]] if you want more information about additional options for the settings.xml file.

44

45

== Step 3: Installing WebObjects Libraries ==

46

47

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:

mvn wobootstrap:install

**NOTE**: WebObjects must be installed.

56

57

**See** the [[maven-wobootstrap-plugin>>doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.

58

59

**See** [[Maven Introduction to Repositories>>url:http://maven.apache.org/guides/introduction/introduction-to-repositories.html||shape="rect"]] if you want more information about Maven repositories.

60

61

62

Do **not** link to or install the WebObjects jars located inside {{code language="none"}}/System/Library/Frameworks{{/code}} or {{code language="none"}}/Library/Frameworks{{/code}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{code language="none"}}/Library/WebObjects/lib{{/code}}. For example, the jar {{code language="none"}}/Library/WebObjects/lib/JavaWebObjects.jar{{/code}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{code language="none"}}/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar{{/code}} does not.

63

64

65

== Step 4: Creating a WebObjects or Wonder Project ==

66

67

Archetypes are the fast way to create a new project using Maven and WOProject provides various archetypes of its own to get you started with WebObjects, or better, Wonder-based applications. Execute the following command to generate a basic Wonder application project:

mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \

72

-DarchetypeGroupId=org.objectstyle.woproject.maven2 \

73

-DarchetypeVersion=2.1

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

78

79

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

80

81

**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].

82

83

**NOTE:** You can see the list of available archetypes in the following location: [[http:~~/~~/wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/>>url:http://wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/||shape="rect"]].

84

85

== Step 5: Importing the Project into Eclipse ==

86

87

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.

88

89

90

As Maven takes care of the dependency management, you must use a mechanism to add the jars to your Eclipse build path. There are 3 options:

91

92

1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.

93

1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.

94

1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.

95

96

97

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.

98

99

**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>doc:General Maven Documentation||anchor="IDE Integration"]].

100

101

== Step 6: Building WebObjects Applications with Maven ==

102

103

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

mvn clean package

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.

112

113

To install your project into your local repository:

mvn clean install