Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 67.1
edited by Lachlan Deck
on 2016/01/13 15:21
Change comment: There is no comment for this version
To version 60.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,82 +1,37 @@
1 -{{tip title="2016 QuickStart"}}
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"]])
1 +== Outline ==
3 3  
4 -**Steps 0-2** (as elaborated below)
5 -
6 -0. Install Java 8
7 -~1. Install Maven 3
8 -2. Update ~~/.m2/settings.xml to include the wocommunity repo
9 -
10 -**Steps 3–6**
11 -
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 via Help > Install New Software.... (See [[http:~~/~~/www.eclipse.org/m2e/>>url:http://www.eclipse.org/m2e/||shape="rect"]])
14 -5. Install [[doc:WOLips]]
15 -6. Preferences > Maven > Archetypes, Add Remote Catalog
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 -
18 -Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
19 -{{/tip}}
20 -
21 -----
22 -
23 -(% style="color: rgb(0,0,0);font-size: 24.0px;" %)Detailed Instructions...
24 -
25 -(% style="color: rgb(0,0,0);font-size: 20.0px;" %)Step 0: Install latest Java
26 -
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 -
29 29  == Step 1: Installing Maven ==
30 30  
31 -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.
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.
32 32  
33 -(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
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:
34 34  
35 -{{code title="MacPorts usage" theme="Emacs" language="bash"}}
36 -$ sudo port install maven3
37 -{{/code}}
10 +{{noformat}}
38 38  
39 -(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
12 +sudo port install maven3
40 40  
41 -{{code title="Homebrew usage" theme="Emacs" language="bash"}}
42 -$ brew install maven
43 -{{/code}}
14 +{{/noformat}}
44 44  
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:
16 +In future, to keep this up to date:
46 46  
47 -{{code title="Manual install" theme="Emacs" language="bash"}}
48 -$ sudo su
49 -$ cd /usr/local/
50 -$ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
51 -$ tar -xzf apache-maven-3.3.3-bin.tar.gz
52 -$ ln -s apache-maven-3.3.3 apache-maven
53 -$ exit
54 -$ cd ~/
55 -$ vi .bash_profile
56 -{{/code}}
18 +{{noformat}}
57 57  
58 -Then in your bash profile, ensure your path and java home are updated:
20 +sudo port upgrade maven3
59 59  
60 -{{code title="~~/.bash_profile" theme="Emacs" linenumbers="true" language="text"}}
61 -...
62 -export PATH=/usr/local/apache-maven/bin:$PATH
63 -export JAVA_HOME=$(/usr/libexec/java_home)
64 -...
65 -{{/code}}
22 +{{/noformat}}
66 66  
67 -
24 +Don't forget to install maven_select:
68 68  
69 -Whichever installation approach you've taken, you should now be able to do
26 +{{noformat}}
70 70  
71 -$ mvn -version
28 +sudo port install maven_select
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.
30 +{{/noformat}}
31 +{{/tip}}
74 74  
75 -**NOTE 2**: You might also like to install bash completion utilities:
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.
76 76  
77 -* 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"]]).
78 -* 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"]]).
79 -
80 80  == Step 2: Configuring your Maven Settings ==
81 81  
82 82  Advanced users can skip this step, but it's highly recommended.
... ... @@ -85,8 +85,6 @@
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  
88 -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
89 -
90 90  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.
91 91  
92 92  == Step 3: Installing WebObjects Libraries ==
... ... @@ -94,13 +94,14 @@
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 96  {{noformat}}
97 -mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
98 98  
51 +mvn wobootstrap:install
52 +
99 99  {{/noformat}}
100 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.
57 +**See** the [[maven-wobootstrap-plugin>>doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
104 104  
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  
... ... @@ -113,6 +113,7 @@
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 115  {{noformat}}
70 +
116 116  mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
117 117   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
118 118   -DarchetypeVersion=2.1
... ... @@ -121,11 +121,11 @@
121 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]].
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]].
125 125  
126 126  **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
127 127  
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"]].
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"]].
129 129  
130 130  == Step 5: Importing the Project into Eclipse ==
131 131  
... ... @@ -148,6 +148,7 @@
148 148  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
149 149  
150 150  {{noformat}}
106 +
151 151  mvn clean package
152 152  
153 153  {{/noformat}}
... ... @@ -157,6 +157,7 @@
157 157  To install your project into your local repository:
158 158  
159 159  {{noformat}}
116 +
160 160  mvn clean install
161 161  
162 162  {{/noformat}}