Clone URL (Committers only):
https://cms.apache.org/redirect?new=gpetracek;action=diff;uri=http://openejb.apache.org/tomee-mp-getting-started.mdtext



Index: trunk/content/tomee-mp-getting-started.mdtext
===================================================================
--- trunk/content/tomee-mp-getting-started.mdtext       (revision 1425910)
+++ trunk/content/tomee-mp-getting-started.mdtext       (working copy)
@@ -1 +1,49 @@
-Title: TomEE Maven Plugin
\ No newline at end of file
+Title: TomEE Maven Plugin
+#  Generating a TomEE-Project with Maven
+
+TomEE provides a maven-archetype for generating a maven based project. This 
template-project is preconfigured with `javaee-api` (scope provided) and with 
the `tomee-maven-plugin` for starting the application with TomEE.
+
+The current version of the archetype is '1.0.1'. So the needed command to 
generate an application is:
+
+    mvn archetype:generate -DarchetypeGroupId=org.apache.openejb.maven 
-DarchetypeArtifactId=tomee-wapp-archetype -DarchetypeVersion=1.0.1
+
+The first time you run this command maven downloads the archetype and some 
parts related to it. Afterwards you see a prompt which allows you to specify 
the groupId, artifactId, version and package of your application.
+If you are using 'tomee' as groupId, 'tomee-demo' as artifactId, '1.0' as 
version and 'myapp' as package, your console should show something like:
+
+    Define value for property 'groupId': : tomee     
+    Define value for property 'artifactId': : tomee-demo
+    Define value for property 'version':  1.0-SNAPSHOT: : 1.0
+    Define value for property 'package':  tomee: : myapp
+    Confirm properties configuration:
+    groupId: tomee
+    artifactId: tomee-demo
+    version: 1.0
+    package: myapp
+    ...
+    [INFO] BUILD SUCCESS
+    ...
+
+Afterwards you see a new folder with the name you used for the artifactId (in 
the previous example 'tomee-demo').
+For starting the application you have to change the current directory to the 
directory of the generated application:
+
+    cd tomee-demo
+
+#  Starting a TomEE-Project with Maven
+
+With using the archetype everything you need is in place already. So you just 
have to start TomEE with:
+
+    mvn package tomee:run
+
+The first time you run this command takes a bit longer, because maven has to 
download e.g. TomEE.
+Once those parts are downloaded, starting maven, deploying and starting the 
generated application takes less than 10s (depending on your computer).
+
+#  Accessing a started application
+
+The application gets deployed to `target/apache-tomee/webapps`. If everything 
worked correctly, you should see two directories ('tomee' and 'tomee-demo-1.0') 
as well as a web-archive ('tomee-demo-1.0.war').
+The mentioned directories are also the context-paths you can access. In our 
example the generated application contains a servlet mapped to '/index'. So you 
can access it via:
+
+    http://localhost:8080/[artifactId]-[version]/index
+
+e.g.:
+
+    http://localhost:8080/tomee-demo-1.0/index

Reply via email to