Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 60.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: There is no comment for this version
To version 69.1
edited by Ray Kiddy
on 2022/06/25 01:49
Change comment: add wuestion in re error

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +WOProject-Maven
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.kiddyr
Content
... ... @@ -1,37 +1,85 @@
1 -== Outline ==
1 +(% class="auto-cursor-target" %)
2 +\\
2 2  
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"]])
6 +
7 +**Steps 0-2** (as elaborated below)
8 +
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 +
3 3  == Step 1: Installing Maven ==
4 4  
5 -Downloading and installing the latest version of [[Maven>>url:http://maven.apache.org/download||shape="rect"]] is the first step to start using this tool.
34 +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.
6 6  
7 -{{tip title="Mac Tip"}}
8 -install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal:
36 +(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
9 9  
10 -{{noformat}}
38 +{{code language="bash" theme="Emacs" title="MacPorts usage"}}
39 +$ sudo port install maven3
40 +{{/code}}
11 11  
12 -sudo port install maven3
42 +(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
13 13  
14 -{{/noformat}}
44 +{{code language="bash" theme="Emacs" title="Homebrew usage"}}
45 +$ brew install maven
46 +{{/code}}
15 15  
16 -In future, to keep this up to date:
48 +(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:
17 17  
18 -{{noformat}}
50 +{{code language="bash" theme="Emacs" title="Manual install"}}
51 +$ sudo su
52 +$ cd /usr/local/
53 +$ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
54 +$ tar -xzf apache-maven-3.3.3-bin.tar.gz
55 +$ ln -s apache-maven-3.3.3 apache-maven
56 +$ exit
57 +$ cd ~/
58 +$ vi .bash_profile
59 +{{/code}}
19 19  
20 -sudo port upgrade maven3
61 +Then in your bash profile, ensure your path and java home are updated:
21 21  
22 -{{/noformat}}
63 +{{code language="text" theme="Emacs" title="~~/.bash_profile" linenumbers="true"}}
64 +...
65 +export PATH=/usr/local/apache-maven/bin:$PATH
66 +export JAVA_HOME=$(/usr/libexec/java_home)
67 +...
68 +{{/code}}
23 23  
24 -Don't forget to install maven_select:
70 +\\
25 25  
26 -{{noformat}}
72 +Whichever installation approach you've taken, you should now be able to do
27 27  
28 -sudo port install maven_select
74 +$ mvn -version
29 29  
30 -{{/noformat}}
31 -{{/tip}}
76 +**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.
32 32  
33 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
78 +**NOTE 2**: You might also like to install bash completion utilities:
34 34  
80 +* See this superuser answer for bash-completion installation: ([[http:~~/~~/superuser.com/questions/288438/bash-completion-for-commands-in-mac-os-x>>url:http://superuser.com/questions/288438/bash-completion-for-commands-in-mac-os-x||shape="rect"]]).
81 +* See also the following github repo for maven-bash-completion: ([[https:~~/~~/github.com/juven/maven-bash-completion>>url:https://github.com/juven/maven-bash-completion||shape="rect"]]).
82 +
35 35  == Step 2: Configuring your Maven Settings ==
36 36  
37 37  Advanced users can skip this step, but it's highly recommended.
... ... @@ -40,6 +40,8 @@
40 40  
41 41  **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.
42 42  
91 +Download the [[archetype-catalog.xml>>url:http://maven.wocommunity.org/content/groups/public/archetype-catalog.xml||shape="rect"]] and copy it to ~~/.m2/archetype-catalog.xml
92 +
43 43  See [[Maven Settings Reference>>url:http://maven.apache.org/settings.html||shape="rect"]] if you want more information about additional options for the settings.xml file.
44 44  
45 45  == Step 3: Installing WebObjects Libraries ==
... ... @@ -47,15 +47,21 @@
47 47  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:
48 48  
49 49  {{noformat}}
100 +mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
50 50  
51 -mvn wobootstrap:install
52 -
53 53  {{/noformat}}
54 54  
55 55  **NOTE**: WebObjects must be installed.
56 56  
57 -**See** the [[maven-wobootstrap-plugin>>doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
58 58  
107 +\\[[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
108 +
109 +{{{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]}}}
110 +
111 +What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
112 +
113 +**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
114 +
59 59  **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.
60 60  
61 61  {{warning title="Installing the right jars!"}}
... ... @@ -67,7 +67,6 @@
67 67  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:
68 68  
69 69  {{noformat}}
70 -
71 71  mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
72 72   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
73 73   -DarchetypeVersion=2.1
... ... @@ -76,11 +76,11 @@
76 76  
77 77  The maven-archetype-plugin will ask the required information to create the new project.
78 78  
79 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>doc:woapplication-archetype]].
134 +**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]].
80 80  
81 81  **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
82 82  
83 -**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"]].
138 +**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"]].
84 84  
85 85  == Step 5: Importing the Project into Eclipse ==
86 86  
... ... @@ -103,7 +103,6 @@
103 103  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
104 104  
105 105  {{noformat}}
106 -
107 107  mvn clean package
108 108  
109 109  {{/noformat}}
... ... @@ -113,7 +113,6 @@
113 113  To install your project into your local repository:
114 114  
115 115  {{noformat}}
116 -
117 117  mvn clean install
118 118  
119 119  {{/noformat}}
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>