Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 26.1
edited by Lachlan Deck
on 2008/11/23 16:15
Change comment: Adding warning about installing the right jars
To version 22.1
edited by egeze
on 2011/05/01 06:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.egeze
Content
... ... @@ -1,3 +1,5 @@
1 +== Outline ==
2 +
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,43 +4,70 @@
4 4  
5 5  {{tip title="Mac Tip"}}
6 6  
7 - install macports [http://www.macports.org/install.php], then on the terminal
8 - {noformat}sudo port install maven2{noformat}
9 +install macports [http://www.macports.org/install.php], then on the terminal{noformat}sudo port install maven2{noformat}
9 9  
10 - In future, to keep this up to date:
11 - {noformat}sudo port upgrade maven2{noformat}
11 +In future, to keep this up to date:{noformat}sudo port upgrade maven2{noformat}
12 12  
13 13  {{/tip}}
14 14  
15 -**NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
15 +**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
16 16  
17 17  == Step 2: Configuring your Maven Settings ==
18 18  
19 -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.,,
19 +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.,,
20 20  
21 -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:
21 +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:
22 22  
23 23  {{noformat}}
24 24  
25 25  <settings xmlns="http://maven.apache.org/POM/4.0.0"
26 - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
27 - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
26 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
27 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
28 28   http://maven.apache.org/xsd/settings-1.0.0.xsd">
29 29   <pluginGroups>
30 30   <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
31 31   </pluginGroups>
32 +
32 32   <profiles>
33 33   <profile>
34 - <id>woproject</id>
35 + <id>default</id>
35 35   <activation>
36 36   <activeByDefault>true</activeByDefault>
37 37   </activation>
39 + <repositories>
40 + <repository>
41 + <id>wocommunity.releases</id>
42 + <name>WOCommunity Releases Repository</name>
43 + <url>
44 + http://maven.wocommunity.org/content/groups/public
45 + </url>
46 + <releases>
47 + <enabled>true</enabled>
48 + </releases>
49 + <snapshots>
50 + <enabled>false</enabled>
51 + </snapshots>
52 + </repository>
53 + <repository>
54 + <id>wocommunity.snapshots</id>
55 + <name>WOCommunity Snapshots Repository</name>
56 + <url>
57 + http://maven.wocommunity.org/content/groups/public-snapshots
58 + </url>
59 + <releases>
60 + <enabled>false</enabled>
61 + </releases>
62 + <snapshots>
63 + <enabled>true</enabled>
64 + </snapshots>
65 + </repository>
66 + </repositories>
38 38   <pluginRepositories>
39 39   <pluginRepository>
40 - <id>mdimension.releases</id>
41 - <name>MDimension Releases Repository</name>
69 + <id>wocommunity.releases</id>
70 + <name>WOCommunity Releases Repository</name>
42 42   <url>
43 - http://webobjects.mdimension.com/maven2/releases
72 + http://maven.wocommunity.org/content/groups/public
44 44   </url>
45 45   <releases>
46 46   <enabled>true</enabled>
... ... @@ -50,10 +50,10 @@
50 50   </snapshots>
51 51   </pluginRepository>
52 52   <pluginRepository>
53 - <id>mdimension.snapshots</id>
54 - <name>MDimension Snapshots Repository</name>
82 + <id>wocommunity.snapshots</id>
83 + <name>WOCommunity Snapshots Repository</name>
55 55   <url>
56 - http://webobjects.mdimension.com/maven2/snapshots
85 + http://maven.wocommunity.org/content/groups/public-snapshots
57 57   </url>
58 58   <releases>
59 59   <enabled>false</enabled>
... ... @@ -69,7 +69,7 @@
69 69  
70 70  {{/noformat}}
71 71  
72 -**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.
101 +**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.
73 73  
74 74  == Step 3: Installing WebObjects Libraries ==
75 75  
... ... @@ -81,7 +81,7 @@
81 81  
82 82  {{/noformat}}
83 83  
84 -**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.
113 +**NOTE**: WebObjects must be installed. See the [[maven-wobootstrap-plugin>>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.
85 85  
86 86  {{warning title="Installing the right jars!"}}
87 87  
... ... @@ -96,15 +96,14 @@
96 96  {{noformat}}
97 97  
98 98  mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
99 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
100 - -DarchetypeVersion=2.0.16 \
101 - -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
128 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
129 + -DarchetypeVersion=2.0.17
102 102  
103 103  {{/noformat}}
104 104  
105 105  The maven-archetype-plugin will ask the required information to create the new project.
106 106  
107 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
135 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>woapplication-archetype]].
108 108  
109 109  **NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
110 110  
... ... @@ -131,8 +131,18 @@
131 131  
132 132  {{noformat}}
133 133  
134 -mvn clean install
162 +mvn clean package
135 135  
136 136  {{/noformat}}
137 137  
138 138  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.
167 +
168 +To install your project into your local repository:
169 +
170 +{{noformat}}
171 +
172 +mvn clean install
173 +
174 +{{/noformat}}
175 +
176 +This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##