Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 32.1
edited by fjecker
on 2008/11/21 08:25
Change comment: Added a missing end tag slash for the settings.xml description
To version 39.1
edited by johnc
on 2009/04/26 18:23
Change comment: Changed -DarchetypeVersion=2.0.16 to 2.0.17

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.fjecker
1 +XWiki.johnc
Content
... ... @@ -1,23 +1,39 @@
1 +== Outline ==
2 +
3 +{{toc style="disc" indent="20px"}}{{/toc}}
4 +
1 1  == Step 1: Installing Maven ==
2 2  
3 3  Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
4 4  
5 -**NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
9 +{{tip title="Mac Tip"}}
6 6  
11 + install macports [http://www.macports.org/install.php], then on the terminal
12 + {noformat}sudo port install maven2{noformat}
13 +
14 + In future, to keep this up to date:
15 + {noformat}sudo port upgrade maven2{noformat}
16 +
17 +{{/tip}}
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.
20 +
7 7  == Step 2: Configuring your Maven Settings ==
8 8  
9 -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.,,
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.,,
10 10  
11 -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:
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:
12 12  
13 13  {{noformat}}
14 14  
15 -<settings>
16 - ...
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">
17 17   <pluginGroups>
18 18   <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
19 19   </pluginGroups>
20 - ...
36 +
21 21   <profiles>
22 22   <profile>
23 23   <id>default</id>
... ... @@ -24,12 +24,40 @@
24 24   <activation>
25 25   <activeByDefault>true</activeByDefault>
26 26   </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>
27 27   <pluginRepositories>
28 28   <pluginRepository>
29 - <id>mdimension.releases</id>
30 - <name>MDimension Releases Repository</name>
73 + <id>wocommunity.releases</id>
74 + <name>WOCommunity Releases Repository</name>
31 31   <url>
32 - http://webobjects.mdimension.com/maven2/releases
76 + http://maven.wocommunity.org/content/groups/public
33 33   </url>
34 34   <releases>
35 35   <enabled>true</enabled>
... ... @@ -39,10 +39,10 @@
39 39   </snapshots>
40 40   </pluginRepository>
41 41   <pluginRepository>
42 - <id>mdimension.snapshots</id>
43 - <name>MDimension Snapshots Repository</name>
86 + <id>wocommunity.snapshots</id>
87 + <name>WOCommunity Snapshots Repository</name>
44 44   <url>
45 - http://webobjects.mdimension.com/maven2/snapshots
89 + http://maven.wocommunity.org/content/groups/public-snapshots
46 46   </url>
47 47   <releases>
48 48   <enabled>false</enabled>
... ... @@ -54,12 +54,11 @@
54 54   </pluginRepositories>
55 55   </profile>
56 56   </profiles>
57 - ...
58 58  </settings>
59 59  
60 60  {{/noformat}}
61 61  
62 -**NOTE**: You can download the complete settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about the settings.xml file.
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.
63 63  
64 64  == Step 3: Installing WebObjects Libraries ==
65 65  
... ... @@ -73,6 +73,12 @@
73 73  
74 74  **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.
75 75  
119 +{{warning title="Installing the right jars!"}}
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.
122 +
123 +{{/warning}}
124 +
76 76  == Step 4: Creating a WebObjects Project ==
77 77  
78 78  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:
... ... @@ -80,9 +80,8 @@
80 80  {{noformat}}
81 81  
82 82  mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
83 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
84 - -DarchetypeVersion=2.0.16 \
85 - -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
132 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
133 + -DarchetypeVersion=2.0.17
86 86  
87 87  {{/noformat}}
88 88  
... ... @@ -115,8 +115,18 @@
115 115  
116 116  {{noformat}}
117 117  
118 -mvn clean install
166 +mvn clean package
119 119  
120 120  {{/noformat}}
121 121  
122 122  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.
171 +
172 +To install your project into your local repository:
173 +
174 +{{noformat}}
175 +
176 +mvn clean install
177 +
178 +{{/noformat}}
179 +
180 +This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##