Changes for page Quick Start

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

From version 64.1
edited by Lachlan Deck
on 2016/01/13 14:41
Change comment: There is no comment for this version
To version 71.2
edited by Paul Hoadley
on 2023/11/13 11:56
Change comment: Updated the relative links.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +WOProject-Maven
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.paulh
Content
... ... @@ -1,9 +1,34 @@
1 -== Outline ==
1 +(% class="auto-cursor-target" %)
2 +\\
2 2  
3 -== Step 0: Install latest Java ==
4 +{{tip title="2016 QuickStart"}}
5 +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"]])
4 4  
5 -If you're on a Mac, it's using old and busted Java 6. Update that to Java 8.
7 +**Steps 0-2** (as elaborated below)
6 6  
9 +0. Install Java 8 (or Java 11 ?)
10 +~1. Install Maven 3
11 +2. Update ~~/.m2/settings.xml to include the wocommunity repo
12 +
13 +**Steps 3–6**
14 +
15 +3. Install Eclipse 4.5 for Committers ([[http:~~/~~/www.eclipse.org/downloads/>>url:http://www.eclipse.org/downloads/||shape="rect"]])
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]]
18 +6. Preferences > Maven > Archetypes, Add Remote Catalog
19 + [[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"]]
20 +
21 +Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
22 +{{/tip}}
23 +
24 +----
25 +
26 +(% style="color: rgb(0,0,0);font-size: 24.0px;" %)Detailed Instructions...
27 +
28 +(% style="color: rgb(0,0,0);font-size: 20.0px;" %)Step 0: Install latest Java
29 +
30 +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"]]).
31 +
7 7  == Step 1: Installing Maven ==
8 8  
9 9  Downloading and installing the latest version of [[Maven>>url:https://maven.apache.org/download.cgi||shape="rect"]] is the first step to start using this tool via one of the following approaches.
... ... @@ -10,19 +10,19 @@
10 10  
11 11  (a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
12 12  
13 -{{code title="MacPorts usage" theme="Emacs" language="bash"}}
38 +{{code language="bash" theme="Emacs" title="MacPorts usage"}}
14 14  $ sudo port install maven3
15 15  {{/code}}
16 16  
17 17  (b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
18 18  
19 -{{code title="Homebrew usage" theme="Emacs" language="bash"}}
44 +{{code language="bash" theme="Emacs" title="Homebrew usage"}}
20 20  $ brew install maven
21 21  {{/code}}
22 22  
23 23  (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:
24 24  
25 -{{code title="Manual install" theme="Emacs" language="bash"}}
50 +{{code language="bash" theme="Emacs" title="Manual install"}}
26 26  $ sudo su
27 27  $ cd /usr/local/
28 28  $ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
... ... @@ -35,7 +35,7 @@
35 35  
36 36  Then in your bash profile, ensure your path and java home are updated:
37 37  
38 -{{code title="~~/.bash_profile" theme="Emacs" linenumbers="true" language="text"}}
63 +{{code language="text" theme="Emacs" title="~~/.bash_profile" linenumbers="true"}}
39 39  ...
40 40  export PATH=/usr/local/apache-maven/bin:$PATH
41 41  export JAVA_HOME=$(/usr/libexec/java_home)
... ... @@ -42,13 +42,13 @@
42 42  ...
43 43  {{/code}}
44 44  
45 -
70 +\\
46 46  
47 47  Whichever installation approach you've taken, you should now be able to do
48 48  
49 49  $ mvn -version
50 50  
51 -**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.
76 +**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.
52 52  
53 53  **NOTE 2**: You might also like to install bash completion utilities:
54 54  
... ... @@ -59,7 +59,7 @@
59 59  
60 60  Advanced users can skip this step, but it's highly recommended.
61 61  
62 -[[doc:Quick Start Maven Settings Configuration Guide]]
87 +[[doc:WOL.Quick Start Maven Settings Configuration Guide]]
63 63  
64 64  **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.
65 65  
... ... @@ -78,8 +78,16 @@
78 78  
79 79  **NOTE**: WebObjects must be installed.
80 80  
81 -**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
82 82  
107 +
108 +[[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
109 +
110 +{{{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]}}}
111 +
112 +What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
113 +
114 +**See** the [[doc:WOL.maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
115 +
83 83  **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.
84 84  
85 85  {{warning title="Installing the right jars!"}}
... ... @@ -99,7 +99,7 @@
99 99  
100 100  The maven-archetype-plugin will ask the required information to create the new project.
101 101  
102 -**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]].
135 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[doc:WOL.woapplication-archetype]].
103 103  
104 104  **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
105 105  
... ... @@ -119,7 +119,7 @@
119 119  
120 120  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.
121 121  
122 -**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"]].
155 +**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"]].
123 123  
124 124  == Step 6: Building WebObjects Applications with Maven ==
125 125  
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>