Developer Materials

kitchensink-html5-mobile


    Body

    What is it?

    The kitchensink-html5-mobile quickstart is based on the kitchensink quickstart and demonstrates a Java EE 7 mobile database application using HTML5, jQuery Mobile, JAX-RS, JPA, and REST in Red Hat JBoss Enterprise Application Platform.

    This application is built using a HTML5 + REST approach. This uses a pure HTML client that interacts with the application server via restful end-points (JAX-RS). This application also uses some of the latest HTML5 features and advanced JAX-RS. And since testing is just as important with client side as it is server side, this application uses QUnit to show you how to unit test your JavaScript.

    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.

    System Requirements

    The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 or later.

    All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven for JBoss EAP 7.1 to make sure you are configured correctly for testing the quickstarts.

    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 are ready to build and deploy.

    Start the Server

    1. Open a command line and navigate to the root of the JBoss EAP directory.
    2. The following shows the command line to start the server with the default profile:
      For Linux:   EAP7_HOME/bin/standalone.sh
      For Windows: EAP7_HOME\bin\standalone.bat
      

    Note: Adding -b 0.0.0.0 to the above commands will allow external clients, such as phones, tablets, and desktops, connect through your local network.

    For example

        For Linux:   EAP7_HOME/bin/standalone.sh -b 0.0.0.0
        For Windows: EAP7_HOME\bin\standalone.bat -b 0.0.0.0
    

    Build and Deploy the Quickstart

    1. Make sure you have started the JBoss EAP server as described above.
    2. Open a command line and navigate to the root directory of this quickstart.
    3. Type this command to build and deploy the archive:
      mvn clean wildfly:deploy
      
    4. This deploys target/kitchensink-html5-mobile.war to the running instance of the server.

    Access the Application

    Access the running client application in a browser at the following URL: http://localhost:8080/kitchensink-html5-mobile/.

    Undeploy the Archive

    1. Make sure you have started the JBoss EAP server as described above.
    2. Open a command line and navigate to the root directory of this quickstart.
    3. When you are finished testing, type this command to undeploy the archive:
      mvn wildfly:undeploy
      

    Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

    You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

    Minification

    By default, the project uses the wro4j plugin, which provides the ability to concatenate, validate and minify JavaScript and CSS files. These minified files, as well as their unmodified versions are deployed with the project.

    With just a few quick changes to the project, you can link to the minified versions of your JavaScript and CSS files.

    First, in the <project-root>/src/main/webapp/index.html file, search for references to minification and comment or uncomment the appropriate lines.

    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: By default there are turn off tests so you must use the arquillian test profile to run tests when minifying. For example:

    #No Tests
    mvn clean wildfly:deploy -Pminify
    

    OR

    #With Tests
    mvn clean verify wildfly:deploy -Pminify,arq-remote
    

    Run 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 verify -Parq-remote
    

    Run the QUnit tests

    QUnit is a JavaScript unit testing framework used and built by jQuery. Because JavaScript code is the core of an HTML5 application, this quickstart provides a set of QUnit tests that automate testing of this code in various browsers.

    Executing QUnit test cases is quite easy. Simply load the following HTML file in the browser you want to test.

        QUICKSTART_HOME/kitchensink-html5-mobile/src/test/qunit/index.html
    

    You can also display the QUnit tests using the Eclipse built-in browser.

    For more information on QUnit tests see http://qunitjs.com/

    Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

    You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

    Debug the Application

    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