Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 54.1
edited by Lachlan Deck
on 2008/12/08 15:48
Change comment: Quick review - adding table of contents, grammar fixes.
To version 59.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: Updating archetypeVersion to use for quick start. Adding reminder about installing maven_select.

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,5 @@
1 1  == Outline ==
2 2  
3 -{{toc style="disc" indent="20px"}}{{/toc}}
4 -
5 5  == Step 1: Installing Maven ==
6 6  
7 7  Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
... ... @@ -8,12 +8,21 @@
8 8  
9 9  {{tip title="Mac Tip"}}
10 10  
11 - install macports [http://www.macports.org/install.php], then on the terminal
12 - {noformat}sudo port install maven2{noformat}
9 +install macports [http://www.macports.org/install.php], then on the terminal:
10 +{noformat}
11 +sudo port install maven3
12 +{noformat}
13 13  
14 - In future, to keep this up to date:
15 - {noformat}sudo port upgrade maven2{noformat}
14 +In future, to keep this up to date:
15 +{noformat}
16 +sudo port upgrade maven3
17 +{noformat}
16 16  
19 +Don't forget to install maven_select:
20 +{noformat}
21 +sudo port install maven_select
22 +{noformat}
23 +
17 17  {{/tip}}
18 18  
19 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,61 +20,14 @@
20 20  
21 21  == Step 2: Configuring your Maven Settings ==
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.,,
30 +Advanced users can skip this step, but it's highly recommended.
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:
32 +[[Quick Start Maven Settings Configuration Guide]]
26 26  
27 -{{noformat}}
34 +**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>^settings.xml]] and install it to /.m2/settings.xml.
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>
36 - <profiles>
37 - <profile>
38 - <id>woproject</id>
39 - <activation>
40 - <activeByDefault>true</activeByDefault>
41 - </activation>
42 - <pluginRepositories>
43 - <pluginRepository>
44 - <id>mdimension.releases</id>
45 - <name>MDimension Releases Repository</name>
46 - <url>
47 - http://webobjects.mdimension.com/maven2/releases
48 - </url>
49 - <releases>
50 - <enabled>true</enabled>
51 - </releases>
52 - <snapshots>
53 - <enabled>false</enabled>
54 - </snapshots>
55 - </pluginRepository>
56 - <pluginRepository>
57 - <id>mdimension.snapshots</id>
58 - <name>MDimension Snapshots Repository</name>
59 - <url>
60 - http://webobjects.mdimension.com/maven2/snapshots
61 - </url>
62 - <releases>
63 - <enabled>false</enabled>
64 - </releases>
65 - <snapshots>
66 - <enabled>true</enabled>
67 - </snapshots>
68 - </pluginRepository>
69 - </pluginRepositories>
70 - </profile>
71 - </profiles>
72 -</settings>
36 +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 -{{/noformat}}
75 -
76 -**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.
77 -
78 78  == Step 3: Installing WebObjects Libraries ==
79 79  
80 80  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:
... ... @@ -85,8 +85,12 @@
85 85  
86 86  {{/noformat}}
87 87  
88 -**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.
48 +**NOTE**: WebObjects must be installed.
89 89  
50 +**See** the [[maven-wobootstrap-plugin>>maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
51 +
52 +**See** [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
53 +
90 90  {{warning title="Installing the right jars!"}}
91 91  
92 92  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.
... ... @@ -93,25 +93,26 @@
93 93  
94 94  {{/warning}}
95 95  
96 -== Step 4: Creating a WebObjects Project ==
60 +== Step 4: Creating a WebObjects or Wonder Project ==
97 97  
98 -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:
62 +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:
99 99  
100 100  {{noformat}}
101 101  
102 -mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
103 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
104 - -DarchetypeVersion=2.0.16 \
105 - -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
66 +mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
67 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
68 + -DarchetypeVersion=2.1
106 106  
107 107  {{/noformat}}
108 108  
109 109  The maven-archetype-plugin will ask the required information to create the new project.
110 110  
111 -**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 [[woapplication-archetype>>woapplication-archetype]].
112 112  
113 -**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>>documentation:Maven Create WO Application Project||anchor="m2eclipse"]].
114 114  
78 +**NOTE:*&nbsp;You can see the list of available archetypes in the following location:&nbsp;[[http://wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/]].**
79 +
115 115  == Step 5: Importing the Project into Eclipse ==
116 116  
117 117  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.
... ... @@ -149,4 +149,4 @@
149 149  
150 150  {{/noformat}}
151 151  
152 -This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##
117 +This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##