What is it?
This is your project! It's a deployable Maven 3 project to help you get your foot in the door developing HTML5 based desktop/mobile web applications with Java EE 6 on JBoss. This project is setup to allow you to create a basic Java EE 6 application using HTML5, jQuery Mobile, JAX-RS, CDI 1.0, EJB 3.1, JPA 2.0 and Bean Validation 1.0. It includes a persistence unit and some sample persistence and transaction code to help you get your feet wet with database access in enterprise Java.
What is a modern web application without mobile web support? This application also integrates jQuery mobile and basic client side device detection to give you both a desktop and mobile version of the interface. Both support the same features, including form validation, member registration, etc. However the mobile version adds in mobile layout, touch, and performance improvements needed to get you started with mobile web development on JBoss.
All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
The application this project produces is designed to be run on JBoss AS 7 or JBoss Enterprise Application Platform 6.
An HTML5 compatible browser such as Chrome, Safari 5+, Firefox 5+, or IE 9+ are required. and note that some behaviors will vary slightly (ex. validations) based on browser support, especially IE 9.
Mobile web support is limited to Android and iOS devices. It should run on HP, and Black Berry devices as well. Windows Phone, and others will be supported as jQuery Mobile announces support.
With the prerequisites out of the way, you're ready to build and deploy.
Deploying the application
First you need to start the JBoss container. To do this, run
or if you are using windows
Note: Adding "-b 0.0.0.0" to the above commands will allow external clients (phones, tablets, desktops, etc...) connect through your local network.
$JBOSS_HOME/bin/standalone.sh -b 0.0.0.0
To deploy the application, you first need to produce the archive to deploy using the following Maven goal:
You can now deploy the artifact by executing the following command:
The client application will be running at the following URL http://localhost:8080/jboss-as-kitchensink-html5-mobile/.
To undeploy run this command:
You can also start the JBoss container and deploy the project using JBoss Tools. See the Getting Started Developing Applications Guide for more information.
Deploying to OpenShift
You can also deploy the application directly to OpenShift, Red Hat's cloud based PaaS offering, follow the instructions here
First, in the
Finally, wro4j runs in the compile phase so any standard build command like package, install, etc. will trigger it. The plugin is in a profile with an id of "minify" so you will want to specify that profile in your maven build.
NOTE: You must either specify the default profile for no tests or the arquillian test profile to run tests when minifying to avoid test errors. For example:
#No Tests mvn clean package jboss-as:deploy -Pminify,default
#With Tests mvn clean package jboss-as:deploy -Pminify,arq-jbossas-remote
Running the Arquillian tests
By default, tests are configured to be skipped. The reason is that the sample test is an Arquillian test, which requires the use of a container. You can activate this test by selecting one of the container configuration provided for JBoss.
To run the test in JBoss, first start the container instance. Then, run the test goal with the following profile activated:
mvn clean test -Parq-jbossas-remote
Running the QUnit tests
For more information on QUnit tests see http://docs.jquery.com/QUnit
Importing the project into an IDE
If you created the project using the Maven archetype wizard in your IDE (Eclipse, NetBeans or IntelliJ IDEA), then there is nothing to do. You should already have an IDE project.
Detailed instructions for using Eclipse / JBoss Tools with are provided in the Getting Started Developing Applications Guide.
If you created the project from the command line using archetype:generate, then you need to import the project into your IDE. If you are using NetBeans 6.8 or IntelliJ IDEA 9, then all you have to do is open the project as an existing project. Both of these IDEs recognize Maven projects natively.
Downloading the sources and Javadocs
If you want to be able to debug into the source code or look at the Javadocs of any library in the project, you can run either of the following two commands to pull them into your local repository. The IDE should then detect them.
mvn dependency:sources mvn dependency:resolve -Dclassifier=javadoc
Find this guide useful?
Find a bug in the guide? Something missing? You can fix it by forking the repository, making the correction and sending a pull request. If you're just plain stuck, feel free to ask a question in the user discussion forum.
- Apr 11, 2013: Jdf-261 - downgrade jquery version to 1.7.1 and make pom.xml and readme use jdf guidelines Rafael Benevides
- Mar 21, 2013: Jdf-235 move aerogear quickstart to jdf Rafael Benevides
- Feb 12, 2013: Add quickstart source repository of record to the readme files Sande Gilda
- Dec 13, 2012: Update readme, aerogear-365 Lucas Holmquist
- Oct 25, 2012: Adding target product and summary aerogear-432 Lucas Holmquist
- Sep 11, 2012: Fix incorrect product targets Sande Gilda
- Sep 11, 2012: Add target product (https://issues.jboss.org/browse/jdf-108) Sande Gilda
- Aug 22, 2012: Merge of changes from the latest updates on aerogear to m5 Bruno Oliveira
- May 11, 2012: Readme maven config updates, change header titles to quickstart folder name, update experience levels, issue 258 Sande Gilda
- May 18, 2012: Move metadata to quickstarts Pete Muir
- Apr 23, 2012: Merging 1.0.0.m3b from aerogear/as-quickstarts Bruno Oliveira
- Mar 13, 2012: Merging 1.0.0.m2c from aerogear/as-quickstarts Kris Borchers
- Jan 26, 2012: Make the readme files consistent with titles, sections (what is it?, etc), and project and product names. uppercase readme.html file names Sande Gilda
- Jan 20, 2012: Moving to top-level Douglas Campos