RichFaces 5 - The next-generation JSF component framework by JBoss, Red Hat
Pull request Compare This branch is 2213 commits behind richfaces:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bom
build
dist
examples
framework
.gitattributes
.gitignore
.gitmodules
.travis.yml
CONTRIBUTING.md
NOTICE.txt
README.md
TESTS.md
buildhive-settings.xml
howto-release.adoc
lgpl.txt
pom.xml

README.md

RichFaces Project Logo

RichFaces 5

The next-generation JSF component framework by JBoss, Red Hat

The RichFaces project is an advanced UI component framework for easily integrating Ajax capabilities into business applications using JSF.

Goal

Version 5

  • New approach to styling based on LESS
  • New components based on third-party widgets
  • Full JSF 2.2 Compatibility
  • Simplified Setup for Users
  • Smooth Migration from RF4 to RF5

Architecture Goals

  • Simplified Framework Build
  • Extensive Integration Testing
  • Fast Development (CDK) & Test Turnaround

see Roadmap for more information.

Project Info

LicenseLGPL v2.1
Build SystemMaven

Getting Started

In order to start with the project, you need just include the RichFaces JARs on the classpath using Maven dependency

<dependency>
    <groupId>org.richfaces</groupId>
    <artifactId>richfaces</artifactId>
    <type>pom</type>
</dependency>

or download the project ZIP distribution from Downloads Page.

Once you have the RichFaces JARs on the classpath, you can start developing by adding JSF page which includes RichFaces taglib from http://richfaces.org/rich namespace:

<!DOCTYPE html>
<html lang="en"
    xmlns="http://www.w3.org/1999/xhtml"
    ...
    xmlns:r="http://richfaces.org/rich">

</html>

For more information on how to get started with the project, see Project Documentation.

Building the Project

Prerequsities:

  • JDK 1.6 +
  • Maven 3.0.4 +

Building the project:

$ mvn clean install

Maven will build the project and execute unit tests, but it won't build distribution or execute integration tests.

Building Project Distribution

$ mvn clean install -Prelease

the ZIP distribution will be stored in dist/target/.

Contributor Getting Started

Read How to Contribute.

Developing the Project

How to Test the Project

RichFaces has extensive framework test suite which validates compatibility with various browsers and application servers.

For more information on how to run and develop this test suite, see Framework Tests document.

Running Smoke Tests

In order to effectively test the project with each code modification, you need to run at least framework's smoke tests:

$ mvn clean install -Dintegration=jbossas71 -Dsmoke

This will run the project tests against managed instance of JBoss AS 7.1 and test it on headless PhantomJS browser.

This step is also executed in the continuous integration job.