Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09

From version 65.1
edited by Lachlan Deck
on 2016/01/13 15:15
Change comment: At 2016 Quickstart tip
To version 76.1
edited by Paul Hoadley
on 2023/12/25 06:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +WOL.Home.WOProject-Maven.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.paulh
Content
... ... @@ -1,9 +1,12 @@
1 +(% class="auto-cursor-target" %)
2 +
3 +
1 1  {{tip title="2016 QuickStart"}}
2 2  See ([[http:~~/~~/lists.apple.com/archives/webobjects-dev/2016/Jan/msg00045.html>>url:http://lists.apple.com/archives/webobjects-dev/2016/Jan/msg00045.html||shape="rect"]])
3 3  
4 4  **Steps 0-2** (as elaborated below)
5 5  
6 -0. Install Java 8
9 +0. Install Java 8 (or Java 11 ?)
7 7  ~1. Install Maven 3
8 8  2. Update ~~/.m2/settings.xml to include the wocommunity repo
9 9  
... ... @@ -10,19 +10,19 @@
10 10  **Steps 3–6**
11 11  
12 12  3. Install Eclipse 4.5 for Committers ([[http:~~/~~/www.eclipse.org/downloads/>>url:http://www.eclipse.org/downloads/||shape="rect"]])
13 -4. Install m2e (Help > Install New Software...)
14 -5. Install WOLips
16 +4. Install m2e via Help > Install New Software.... (See [[http:~~/~~/www.eclipse.org/m2e/>>url:http://www.eclipse.org/m2e/||shape="rect"]])
17 +5. Install [[doc:WOLips]]
15 15  6. Preferences > Maven > Archetypes, Add Remote Catalog
16 16   [[http:~~/~~/maven.wocommunity.org/service/local/repositories/snapshots/content/archetype-catalog.xml>>url:http://maven.wocommunity.org/service/local/repositories/snapshots/content/archetype-catalog.xml||shape="rect"]]
17 17  
18 -[[url:http://maven.wocommunity.org/service/local/repositories/snapshots/content/archetype-catalog.xml||shape="rect"]]Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
21 +Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
19 19  {{/tip}}
20 20  
21 21  ----
22 22  
23 -(% style="color: rgb(0,0,0);font-size: 24.0px;" %)Detailed Instructions...
26 +(% style="color:#000000; font-size:24.0px" %)Detailed Instructions...
24 24  
25 -(% style="color: rgb(0,0,0);font-size: 20.0px;" %)Step 0: Install latest Java
28 +(% style="color:#000000; font-size:20.0px" %)Step 0: Install latest Java
26 26  
27 27  If you're on a Mac, it's using old and busted Java 6. Update that to Java 8 ([[http:~~/~~/www.oracle.com/technetwork/java/javase/downloads/index.html>>url:http://www.oracle.com/technetwork/java/javase/downloads/index.html||shape="rect"]]).
28 28  
... ... @@ -32,19 +32,19 @@
32 32  
33 33  (a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
34 34  
35 -{{code title="MacPorts usage" theme="Emacs" language="bash"}}
38 +{{code language="bash" theme="Emacs" title="MacPorts usage"}}
36 36  $ sudo port install maven3
37 37  {{/code}}
38 38  
39 39  (b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
40 40  
41 -{{code title="Homebrew usage" theme="Emacs" language="bash"}}
44 +{{code language="bash" theme="Emacs" title="Homebrew usage"}}
42 42  $ brew install maven
43 43  {{/code}}
44 44  
45 45  (c) Or manually by downloading the binary tarball, copying it to /usr/local/, unpacking it, soft linking it and adding the path to your bash_profile:
46 46  
47 -{{code title="Manual install" theme="Emacs" language="bash"}}
50 +{{code language="bash" theme="Emacs" title="Manual install"}}
48 48  $ sudo su
49 49  $ cd /usr/local/
50 50  $ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
... ... @@ -57,7 +57,7 @@
57 57  
58 58  Then in your bash profile, ensure your path and java home are updated:
59 59  
60 -{{code title="~~/.bash_profile" theme="Emacs" linenumbers="true" language="text"}}
63 +{{code language="text" theme="Emacs" linenumbers="true" title="/.bash_profile"}}
61 61  ...
62 62  export PATH=/usr/local/apache-maven/bin:$PATH
63 63  export JAVA_HOME=$(/usr/libexec/java_home)
... ... @@ -64,13 +64,12 @@
64 64  ...
65 65  {{/code}}
66 66  
67 -
68 68  
69 69  Whichever installation approach you've taken, you should now be able to do
70 70  
71 71  $ mvn -version
72 72  
73 -**NOTE 1**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
75 +**NOTE 1**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:WOL.Home.WOProject-Maven.General Maven Documentation.WebHome]] for more information.
74 74  
75 75  **NOTE 2**: You might also like to install bash completion utilities:
76 76  
... ... @@ -81,7 +81,7 @@
81 81  
82 82  Advanced users can skip this step, but it's highly recommended.
83 83  
84 -[[doc:Quick Start Maven Settings Configuration Guide]]
86 +[[doc:WOL.Home.WOProject-Maven.Quick Start.Quick Start Maven Settings Configuration Guide.WebHome]]
85 85  
86 86  **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.
87 87  
... ... @@ -93,15 +93,20 @@
93 93  
94 94  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:
95 95  
96 -{{noformat}}
97 -mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
98 +{{{mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3}}}
98 98  
99 -{{/noformat}}
100 -
101 101  **NOTE**: WebObjects must be installed.
102 102  
103 -**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
104 104  
103 +
104 +[[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
105 +
106 +{{{NOTE: [ERROR] No plugin found for prefix 'wobootstrap' in the current project and in the plugin groups [org.apache.maven.plugins, org.codehaus.mojo] available from the repositories [local (/home/ray/.m2/repository), central ()] > [Help 1]}}}
107 +
108 +What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
109 +
110 +**See** the [[doc:WOL.Home.WOProject-Maven.maven-wobootstrap-plugin.WebHome]] documentation for more information and options for specifying a specific version.
111 +
105 105  **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.
106 106  
107 107  {{warning title="Installing the right jars!"}}
... ... @@ -112,18 +112,15 @@
112 112  
113 113  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:
114 114  
115 -{{noformat}}
116 -mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
122 +{{{mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
117 117   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
118 - -DarchetypeVersion=2.1
124 + -DarchetypeVersion=2.1}}}
119 119  
120 -{{/noformat}}
121 -
122 122  The maven-archetype-plugin will ask the required information to create the new project.
123 123  
124 -**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]].
128 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[doc:WOL.Home.WOProject-Maven.woapplication-archetype.WebHome]].
125 125  
126 -**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
130 +**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Home.WOLips Tutorials.Maven Create WO Application Project.WebHome||anchor="m2eclipse"]].
127 127  
128 128  **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"]].
129 129  
... ... @@ -141,24 +141,18 @@
141 141  
142 142  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.
143 143  
144 -**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"]].
148 +**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>doc:WOL.Home.WOProject-Maven.General Maven Documentation.WebHome||anchor="IDE Integration"]].
145 145  
146 146  == Step 6: Building WebObjects Applications with Maven ==
147 147  
148 148  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
149 149  
150 -{{noformat}}
151 -mvn clean package
154 +{{{mvn clean package}}}
152 152  
153 -{{/noformat}}
154 -
155 155  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.
156 156  
157 157  To install your project into your local repository:
158 158  
159 -{{noformat}}
160 -mvn clean install
160 +{{{mvn clean install}}}
161 161  
162 -{{/noformat}}
163 -
164 164  This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}
settings.xml
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +1.9 KB
Content
... ... @@ -1,0 +1,73 @@
1 +<settings xmlns="http://maven.apache.org/POM/4.0.0"
2 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
4 + http://maven.apache.org/xsd/settings-1.0.0.xsd">
5 + <pluginGroups>
6 + <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
7 + </pluginGroups>
8 +
9 + <profiles>
10 + <profile>
11 + <id>default</id>
12 + <activation>
13 + <activeByDefault>true</activeByDefault>
14 + </activation>
15 + <repositories>
16 + <repository>
17 + <id>wocommunity.releases</id>
18 + <name>WOCommunity Releases Repository</name>
19 + <url>
20 + http://maven.wocommunity.org/content/groups/public
21 + </url>
22 + <releases>
23 + <enabled>true</enabled>
24 + </releases>
25 + <snapshots>
26 + <enabled>false</enabled>
27 + </snapshots>
28 + </repository>
29 + <repository>
30 + <id>wocommunity.snapshots</id>
31 + <name>WOCommunity Snapshots Repository</name>
32 + <url>
33 + http://maven.wocommunity.org/content/groups/public-snapshots
34 + </url>
35 + <releases>
36 + <enabled>false</enabled>
37 + </releases>
38 + <snapshots>
39 + <enabled>true</enabled>
40 + </snapshots>
41 + </repository>
42 + </repositories>
43 + <pluginRepositories>
44 + <pluginRepository>
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 + </pluginRepository>
57 + <pluginRepository>
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 + </pluginRepository>
70 + </pluginRepositories>
71 + </profile>
72 + </profiles>
73 +</settings>