Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 48.1
edited by johnc
on 2009/04/08 20:19
Change comment: Updated settings.xml to latest version specified in http://wiki.objectstyle.org/confluence/display/WOL/mail/4129472
To version 61.1
edited by Ramsey Gurley
on 2015/04/30 21:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.johnc
1 +XWiki.ramsey
Content
... ... @@ -1,162 +1,97 @@
1 1  == Outline ==
2 2  
3 -{{toc style="disc" indent="20px"}}{{/toc}}
4 -
5 5  == Step 1: Installing Maven ==
6 6  
7 -Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
5 +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.
8 8  
9 9  {{tip title="Mac Tip"}}
8 +install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal:
10 10  
11 - install macports [http://www.macports.org/install.php], then on the terminal
12 - {noformat}sudo port install maven2{noformat}
10 +{{noformat}}
11 +sudo port install maven3
13 13  
14 - In future, to keep this up to date:
15 - {noformat}sudo port upgrade maven2{noformat}
13 +{{/noformat}}
16 16  
17 -{{/tip}}
15 +In future, to keep this up to date:
18 18  
19 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
17 +{{noformat}}
18 +sudo port upgrade maven3
20 20  
21 -== Step 2: Configuring your Maven Settings ==
20 +{{/noformat}}
22 22  
23 -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 in a folder called ##.m2## in each user's home directory (,,/.m2 on Unix systems and C:ocuments and SettingsserNamem2 on Windows). If this file does not yet exist, you can just create it.,,
22 +Don't forget to install maven_select:
24 24  
25 -You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following xml is sufficient to configure maven for using WOProject-maven plugin:
26 -
27 27  {{noformat}}
25 +sudo port install maven_select
28 28  
29 -<settings xmlns="http://maven.apache.org/POM/4.0.0"
30 - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
31 - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
32 - http://maven.apache.org/xsd/settings-1.0.0.xsd">
33 - <pluginGroups>
34 - <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
35 - </pluginGroups>
27 +{{/noformat}}
28 +{{/tip}}
36 36  
37 - <profiles>
38 - <profile>
39 - <id>default</id>
40 - <activation>
41 - <activeByDefault>true</activeByDefault>
42 - </activation>
43 - <repositories>
44 - <repository>
45 - <id>wocommunity.releases</id>
46 - <name>WOCommunity Releases Repository</name>
47 - <url>
48 - http://maven.wocommunity.org/content/groups/public
49 - </url>
50 - <releases>
51 - <enabled>true</enabled>
52 - </releases>
53 - <snapshots>
54 - <enabled>false</enabled>
55 - </snapshots>
56 - </repository>
57 - <repository>
58 - <id>wocommunity.snapshots</id>
59 - <name>WOCommunity Snapshots Repository</name>
60 - <url>
61 - http://maven.wocommunity.org/content/groups/public-snapshots
62 - </url>
63 - <releases>
64 - <enabled>false</enabled>
65 - </releases>
66 - <snapshots>
67 - <enabled>true</enabled>
68 - </snapshots>
69 - </repository>
70 - </repositories>
71 - <pluginRepositories>
72 - <pluginRepository>
73 - <id>wocommunity.releases</id>
74 - <name>WOCommunity Releases Repository</name>
75 - <url>
76 - http://maven.wocommunity.org/content/groups/public
77 - </url>
78 - <releases>
79 - <enabled>true</enabled>
80 - </releases>
81 - <snapshots>
82 - <enabled>false</enabled>
83 - </snapshots>
84 - </pluginRepository>
85 - <pluginRepository>
86 - <id>wocommunity.snapshots</id>
87 - <name>WOCommunity Snapshots Repository</name>
88 - <url>
89 - http://maven.wocommunity.org/content/groups/public-snapshots
90 - </url>
91 - <releases>
92 - <enabled>false</enabled>
93 - </releases>
94 - <snapshots>
95 - <enabled>true</enabled>
96 - </snapshots>
97 - </pluginRepository>
98 - </pluginRepositories>
99 - </profile>
100 - </profiles>
101 -</settings>
30 +**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
102 102  
103 -{{/noformat}}
32 +== Step 2: Configuring your Maven Settings ==
104 104  
105 -**NOTE**: You can download the complete and most recent settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about additional options for the settings.xml file.
34 +Advanced users can skip this step, but it's highly recommended.
106 106  
36 +[[doc:Quick Start Maven Settings Configuration Guide]]
37 +
38 +**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.
39 +
40 +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.
41 +
107 107  == Step 3: Installing WebObjects Libraries ==
108 108  
109 -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:
44 +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>>url:http://wocreator.sourceforge.net/repository-howto.html||shape="rect"]] to accomplish this:
110 110  
111 111  {{noformat}}
112 -
113 113  mvn wobootstrap:install
114 114  
115 115  {{/noformat}}
116 116  
117 -**NOTE**: WebObjects must be installed. See the [[maven-wobootstrap-plugin]] documentation for more information. See [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
51 +**NOTE**: WebObjects must be installed.
118 118  
119 -{{warning title="Installing the right jars!"}}
53 +**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
120 120  
121 -Do *not* link to or install the WebObjects jars located inside {{/System/Library/Frameworks}} or {{/Library/Frameworks}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{/Library/WebObjects/lib}}. For example, the jar {{/Library/WebObjects/lib/JavaWebObjects.jar}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar}} does not.
55 +**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.
122 122  
57 +{{warning title="Installing the right jars!"}}
58 +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.
123 123  {{/warning}}
124 124  
125 -== Step 4: Creating a WebObjects Project ==
61 +== Step 4: Creating a WebObjects or Wonder Project ==
126 126  
127 -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:
63 +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:
128 128  
129 129  {{noformat}}
130 -
131 -mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
66 +mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
132 132   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
133 - -DarchetypeVersion=2.0.16 \
134 - -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
68 + -DarchetypeVersion=2.1
135 135  
136 136  {{/noformat}}
137 137  
138 138  The maven-archetype-plugin will ask the required information to create the new project.
139 139  
140 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
74 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[doc:woapplication-archetype]].
141 141  
142 -**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
76 +**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
143 143  
78 +**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"]].
79 +
144 144  == Step 5: Importing the Project into Eclipse ==
145 145  
146 146  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.
147 147  
148 148  {{note title="Warning"}}
149 -
150 150  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:
151 -# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
152 -# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
153 -# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
154 154  
87 +1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
88 +1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
89 +1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
155 155  {{/note}}
156 156  
157 157  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.
158 158  
159 -**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>General Maven Documentation||anchor="IDE Integration"]].
94 +**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"]].
160 160  
161 161  == Step 6: Building WebObjects Applications with Maven ==
162 162  
... ... @@ -163,7 +163,6 @@
163 163  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
164 164  
165 165  {{noformat}}
166 -
167 167  mvn clean package
168 168  
169 169  {{/noformat}}
... ... @@ -173,9 +173,8 @@
173 173  To install your project into your local repository:
174 174  
175 175  {{noformat}}
176 -
177 177  mvn clean install
178 178  
179 179  {{/noformat}}
180 180  
181 -This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##
114 +This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}