Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 35.1
edited by Lachlan Deck
on 2008/11/23 15:41
Change comment: Adjusting settings example so as to be immediately pasted into file to use
To version 53.1
edited by Lachlan Deck
on 2008/12/08 15:48
Change comment: Quick review - adding table of contents, grammar fixes.

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,7 @@
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.
... ... @@ -12,13 +12,13 @@
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.
19 +**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.,,
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.,,
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:
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:
22 22  
23 23  {{noformat}}
24 24  
... ... @@ -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.
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.
73 73  
74 74  == Step 3: Installing WebObjects Libraries ==
75 75  
... ... @@ -83,6 +83,12 @@
83 83  
84 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.
85 85  
90 +{{warning title="Installing the right jars!"}}
91 +
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 +
94 +{{/warning}}
95 +
86 86  == Step 4: Creating a WebObjects Project ==
87 87  
88 88  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:
... ... @@ -125,8 +125,18 @@
125 125  
126 126  {{noformat}}
127 127  
128 -mvn clean install
138 +mvn clean package
129 129  
130 130  {{/noformat}}
131 131  
132 132  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.
143 +
144 +To install your project into your local repository:
145 +
146 +{{noformat}}
147 +
148 +mvn clean install
149 +
150 +{{/noformat}}
151 +
152 +This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##