Changes for page Quick Start

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

From 71.2 to 71.1 From 77.2 to 77.1

From version 77.1

edited by Paul Hoadley
on 2023/12/25 09:20

Change comment: Updates and simplifies these instructions.

To version 71.2

edited by Paul Hoadley
on 2023/11/13 11:56

Change comment: Updated the relative links.

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Parent

@@ -1,1 +1,1 @@
--WOL.Home.WOProject-Maven.WebHome
++WOProject-Maven

Content

@@ -1,138 +1,175 @@
  (% class="auto-cursor-target" %)
--You should be able to get a "Hello, World!" Wonder application running using Maven in about 10 minutes.
++\\
--(% class="auto-cursor-target" %)
--= Assumptions =
++{{tip title="2016 QuickStart"}}
++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"]])
--We're going to make a few assumptions to keep this page brief:
++**Steps 0-2** (as elaborated below)
--1. You are running macOS X. You can probably get a WebObjects development environment up on a different OS, but we won't cover that here.
--1. You have Java installed. //We are actually going to assume you're using Java 8//, but only because it's just marginally easier to launch the application under Java 8. People are running WebObjects on Java 21 in production.
--1. You have Eclipse and WOLips installed. Eclipse versions as recent as 2023-09 have been shown to be just fine, albeit with a slightly modified WOLips. Again we won't cover any of that here.
++0. Install Java 8 (or Java 11 ?)
++~1.  Install Maven 3
++2. Update ~~/.m2/settings.xml to include the wocommunity repo
--(% class="auto-cursor-target" %)
--= Setup =
++**Steps 3–6**
--(% class="auto-cursor-target" %)
--You need to install Maven. [[Download the latest version of Maven>>https://maven.apache.org/download.cgi]] from Apache.
++3. Install Eclipse 4.5 for Committers ([[http:~~/~~/www.eclipse.org/downloads/>>url:http://www.eclipse.org/downloads/||shape="rect"]])
++4. Install m2e via Help > Install New Software.... (See [[http:~~/~~/www.eclipse.org/m2e/>>url:http://www.eclipse.org/m2e/||shape="rect"]])
++5. Install [[doc:WOLips]]
++6. Preferences > Maven > Archetypes, Add Remote Catalog
++    [[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"]]
--(% class="auto-cursor-target" %)
--{{{$ cd ~/Applications
--$ curl -O https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.zip
--$ unzip apache-maven-3.9.6-bin.zip
--$ ln -s apache-maven-3.9.6 apache-maven
--}}}
++Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
++{{/tip}}
--Add ##bin## to your path in your shell's startup file, say ##~~/.zshrc##.
++----
--{{{PATH=$PATH:/Users/paulh/Applications/apache-maven-3.9.6/bin
--}}}
++(% style="color: rgb(0,0,0);font-size: 24.0px;" %)Detailed Instructions...
--(% class="auto-cursor-target" %)
--Confirm you have it installed:
++(% style="color: rgb(0,0,0);font-size: 20.0px;" %)Step 0: Install latest Java
--(% class="auto-cursor-target" %)
--{{{$ mvn --version
--Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae)
--}}}
++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"]]).
--(% class="auto-cursor-target" %)
--Finally, add ~~/.m2/settings.xml:
++== Step 1: Installing Maven ==
--(% class="auto-cursor-target" %)
--{{{<settings xmlns="http://maven.apache.org/POM/4.0.0"
-- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
--                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
--  <profiles>
--    <profile>
--      <id>wocommunity</id>
--      <activation>
--        <activeByDefault>true</activeByDefault>
--      </activation>
--      <repositories>
--        <repository>
--          <id>wocommunity</id>
--          <url>https://maven.wocommunity.org/content/groups/public/</url>
--          <releases>
--            <enabled>true</enabled>
--          </releases>
--          <snapshots>
--            <enabled>true</enabled>
--          </snapshots>
--        </repository>
--      </repositories>
--      <pluginRepositories>
--        <pluginRepository>
--          <id>wocommunity</id>
--          <url>https://maven.wocommunity.org/content/groups/public/</url>
--          <releases>
--            <enabled>true</enabled>
--          </releases>
--          <snapshots>
--            <enabled>false</enabled>
--          </snapshots>
--        </pluginRepository>
--      </pluginRepositories>
--    </profile>
--  </profiles>
--</settings>
--}}}
++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.
--(% class="auto-cursor-target" %)
--= Create a new application project =
++(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
--(% class="auto-cursor-target" %)
--Make a new directory somewhere, and run:
++{{code language="bash" theme="Emacs" title="MacPorts usage"}}
++$ sudo port install maven3
++{{/code}}
--{{{$ mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
--        -DarchetypeGroupId=org.wocommunity \
--        -DarchetypeVersion=3.0 -DaskForDefaultPropertyValues=true}}}
++(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
--(% class="auto-cursor-target" %)
--After some downloading, Maven will prompt you:
++{{code language="bash" theme="Emacs" title="Homebrew usage"}}
++$ brew install maven
++{{/code}}
--(% class="auto-cursor-target" %)
--{{{Define value for property 'JavaVersion' 1.8: : 1.8
--Define value for property 'WonderVersion' 7.2: : 7.4
--Define value for property 'groupId': example.app
--Define value for property 'artifactId': Foo
--Define value for property 'version' 1.0-SNAPSHOT: : 0.1-SNAPSHOT
--Define value for property 'package' example.app: : example.app.foo}}}
++(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:
--(% class="auto-cursor-target" %)
--You can enter your own values if you like, but remember to stick with Java 1.8 for the moment. Hit 'Y' to confirm when requested.
++{{code language="bash" theme="Emacs" title="Manual install"}}
++$ sudo su
++$ cd /usr/local/
++$ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
++$ tar -xzf apache-maven-3.3.3-bin.tar.gz
++$ ln -s apache-maven-3.3.3 apache-maven
++$ exit
++$ cd ~/
++$ vi .bash_profile
++{{/code}}
--(% class="auto-cursor-target" %)
--= Build and launch the application =
++Then in your bash profile, ensure your path and java home are updated:
--(% class="auto-cursor-target" %)
--From the same directory, run:
++{{code language="text" theme="Emacs" title="~~/.bash_profile" linenumbers="true"}}
++...
++export PATH=/usr/local/apache-maven/bin:$PATH
++export JAVA_HOME=$(/usr/libexec/java_home)
++...
++{{/code}}
--(% class="auto-cursor-target" %)
--{{{$ cd Foo
--$ mvn package}}}
++\\
--(% class="auto-cursor-target" %)
--Once Maven has finished building, you can launch:
++Whichever installation approach you've taken, you should now be able to do
--(% class="auto-cursor-target" %)
--{{{$ ./target/Foo.woa/Foo}}}
++$ mvn -version
--(% class="auto-cursor-target" %)
--A browser should open and show:
++**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.
-->Hello WOnder world!
++**NOTE 2**: You might also like to install bash completion utilities:
--(% class="auto-cursor-target" %)
--= Import your project into Eclipse =
++* 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"]]).
++* 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"]]).
--(% class="auto-cursor-target" %)
--A final, optional step is to bring the project into Eclipse.
++== Step 2: Configuring your Maven Settings ==
--1. File > Import... > Maven > Existing Maven Projects
--1. Using the file browser, find the top-level "Foo" folder containing the project you created above, click Open.
--1. Ensure ##pom.xml## is checked and click Finish.
++Advanced users can skip this step, but it's highly recommended.
--(% class="auto-cursor-target" %)
--You're done.
++[[doc:WOL.Quick Start Maven Settings Configuration Guide]]
++
++**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.
++
++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
++
++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.
++
++== Step 3: Installing WebObjects Libraries ==
++
++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:
++
++{{noformat}}
++mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
++
++{{/noformat}}
++
++**NOTE**: WebObjects must be installed.
++
++
++
++[[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
++
++{{{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 ()] &#x3e; [Help 1]}}}
++
++What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
++
++**See** the [[doc:WOL.maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
++
++**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.
++
++{{warning title="Installing the right jars!"}}
++Do **not** link to or install the WebObjects jars located inside {{code language="none"}}/System/Library/Frameworks{{/code}} or {{code language="none"}}/Library/Frameworks{{/code}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{code language="none"}}/Library/WebObjects/lib{{/code}}. For example, the jar {{code language="none"}}/Library/WebObjects/lib/JavaWebObjects.jar{{/code}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{code language="none"}}/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar{{/code}} does not.
++{{/warning}}
++
++== Step 4: Creating a WebObjects or Wonder Project ==
++
++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:
++
++{{noformat}}
++mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
++        -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
++        -DarchetypeVersion=2.1
++
++{{/noformat}}
++
++The maven-archetype-plugin will ask the required information to create the new project.
++
++**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]].
++
++**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
++
++**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"]].
++
++== Step 5: Importing the Project into Eclipse ==
++
++The new project is ready to be imported into Eclipse workspace. Use the Eclipse's import wizard (File > Import...) and choose the option "Existing Projects into Workspace". Select the root directory of your new project and finish the import wizard.
++
++{{note title="Warning"}}
++As Maven takes care of the dependency management, you must use a mechanism to add the jars to your Eclipse build path. There are 3 options:
++
++1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
++1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
++1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
++{{/note}}
++
++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.
++
++**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"]].
++
++== Step 6: Building WebObjects Applications with Maven ==
++
++Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
++
++{{noformat}}
++mvn clean package
++
++{{/noformat}}
++
++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.
++
++To install your project into your local repository:
++
++{{noformat}}
++mvn clean install
++
++{{/noformat}}
++
++This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}

Changes for page Quick Start

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?