Skip to content
This repository has been archived by the owner on Nov 16, 2017. It is now read-only.

Commit

Permalink
RF-12849: readme updated - removed obsolete info
Browse files Browse the repository at this point in the history
* added reference to JBoss Tools and JBDS download page
* added info about EAP 6
* removed running mvn eclipse:eclipse as it is not needed
* removed altering of the deployment assembly
* reference on online showcase moved to the top
  • Loading branch information
jhuska committed Apr 18, 2013
1 parent d0c9036 commit 5587926
Showing 1 changed file with 17 additions and 22 deletions.
39 changes: 17 additions & 22 deletions README.md
Expand Up @@ -2,10 +2,11 @@ RichFaces Showcase
==================

**RichFaces: Ajax enabled JSF 2.0 component library**


**Online demo <http://showcase.richfaces.org>**

* RichFaces 4.3.2-SNAPSHOT
* <http://richfaces.org>
* March 2011
* This software is distributed under the terms of the FSF Lesser Gnu Public License (see lgpl.txt)

RichFaces showcase is an application created to show **RichFaces components
Expand All @@ -28,13 +29,14 @@ Requirements
In order to build the Showcase application you will need:

* Maven 3.0.3 or later
* Servers: Apache Tomcat 6.0 or any Java
* Servers: Apache Tomcat 6.0.x/7.0.x or any Java
EE 6 application server (e.g. JBoss AS 7)
* JDK 1.6
* JDK 1.6 or better

Also optional Additional Software would make it easy for you to work with the sources of the application:

* *Eclipse IDE* + *JBoss Tools* (to explore and run the application in IDE). You're obviously free to use any other IDE you wish, but JBoss Tools is recommended.
* *Eclipse IDE* + *JBoss Tools* (to explore and run the application in IDE). You're obviously free to use any other IDE you wish, but JBoss Tools is recommended. Check <http://www.jboss.org/tools/download> out for tools downloading.
* Another option is to use *JBoss Developer Studio*, where you can find all required plugins pre installed for better convenience. Check <https://devstudio.jboss.com/download/6.x.html> out for developer studio downloading.

Build / Deploy
--------------
Expand All @@ -49,15 +51,15 @@ When you see the `BUILD SUCCESSFUL` message you can deploy the
application on the server. To deploy it on Tomcat, copy the *.war*
file from `target` folder to ``TOMCAT_HOME/webapps`` folder. Then, launch the *startup.sh* or *startup.bat* script from ``TOMCAT_HOME/bin/`` directory to start the server.

### Deploying on JBoss AS 7
### Deploying on JBoss AS 7 / EAP 6

To build the project for a JEE6 server you need to navigate to the ``/examples/richfaces-showcase`` and run

for JBoss AS 7.0.x:

mvn clean package -Pjbas7

or for JBoss AS 7.1.x
or for JBoss AS 7.1.x / EAP 6

mvn clean package -Pjbas71

Expand All @@ -66,7 +68,7 @@ When you see the `BUILD SUCCESSFUL` message you can deploy the application on th
First, make sure the application server is running. To start the server:
launch the `standalone.sh` or `standalone.bat` script from ``JBOSS_HOME/bin/`` together with parameter ``--server-config=standalone-full.xml`` for both latest JBoss AS 7.1.x and for latest JBoss AS 7.0.x.

As of `JBoss AS 7.1` you must create the **JMS user account/password** to enable the JMS push sample. Add a new user to the ApplicationRealm with the ``$JBOSS_HOME/bin/add-user.bat`` or ``add-user.sh`` script, with the:
As of `JBoss AS 7.1 / EAP 6` you must create the **JMS user account/password** to enable the JMS push sample. Add a new user to the ApplicationRealm with the ``$JBOSS_HOME/bin/add-user.bat`` or ``add-user.sh`` script, with the:

username: guest
password: password
Expand All @@ -78,10 +80,12 @@ To **deploy** it on the application server, use either:

mvn jboss-as:deploy -Pjbas7

2. or copy the `.war` file from `target` folder to the folder: ``JBOSS_HOME/standalone/deployments``
2. or use the server's management console, which is bound by default at <http://localhost:9990>

3. or copy the `.war` file from `target` folder to the folder: ``JBOSS_HOME/standalone/deployments``

After deploying the examples to your server open a browser and type
<http://localhost:8080/richfaces-showcase> to view the examples.
<http://localhost:8080/showcase> to view the examples. Note that the URL depends on the context on which your application server deployed the showcase application.


Setting up Eclipse to work with the showcase
Expand All @@ -95,23 +99,13 @@ the examples as maven-based projects.
* Expand the project type named Maven and select Import Maven Project
* Browse the directory in which you placed the examples, select it and press OK.
* Press next on the import wizard to finish importing the examples.
2. Or if you are not using *m2eclipse* execute use Maven to convert the
project to an Eclipse project:
* Open a terminal inside the RichFaces examples directory
* execute ``mvn eclipse:eclipse``
* Open Eclipse and select `File > Import`
* Select Import as existing project into workspace after build is complete.
* Follow the instructions on the import wizard.

**You are now able to work with the Showcase within Eclipse.**
**You are now able to work with the Showcase within Eclipse.** Note that by using JBoss Developer Studio you can skip installing all of the required plugins and you can import the project right away.

* In order to deploy the Showcase on the JBoss AS 7.1.x from the Eclipse one needs to:
* Select the right maven profile: ``jbas71``
* Either by pressing hot key `CTRL + ALT + P`, while the showcase project is selected
* Or right click on the showcase project in the `project explorer --> Properties --> Maven` and fill in the input: `jbas71`
* Alter the deployment assembly
* Right click on the `showcase project --> Properties --> Deployment assembly`. By default there should be: ``src/main/java``, ``src/main/resources``, ``src/main/resources-jbas71/``, ``src/main/webapp``
* One needs to add ``src/main/webapp-jbas71``: hit the add button and select the folder option, find the ``webapp-jbas71`` and add it
* Now the showcase can be **deployed**, be sure that you are loading the showcase application on the correct context root and also that there was not added a default `persistence.xml` in ``src/main/resources/META-INF`` (delete it). The URL one should access looks like: <http://localhost:8080/showcase>


Expand Down Expand Up @@ -146,4 +140,5 @@ You will see the showcase has been modified to fit and **dynamically** adjust to

We removed some components from the RichFaces Mobile Showcase which were not mobile ready. For example, ``rich:tooltip``, ``rich:extendedDataTable``, ``rich:jquery``, and ``rich:popupPanel`` either did not make sense in a mobile environment or needed a heavy rewrite for touch interfaces.

``rich:dragDrop`` however, does work on iOS Mobile Safari, but not on Android. To use ``rich:dragDrop`` in Mobile Safari browsers, you can include this snippet of [JavaScript](https://github.com/richfaces/components/blob/develop/mobile-compatibility/rf-dnd.js) at the bottom of your JSF template.
``rich:dragDrop`` however, does work on iOS Mobile Safari, but not on Android. To use ``rich:dragDrop`` in Mobile Safari browsers, you can include this snippet of [JavaScript](https://github.com/richfaces/components/blob/develop/mobile-compatibility/rf-dnd.js) at the bottom of your JSF template.

0 comments on commit 5587926

Please sign in to comment.