The RichFaces project is an advanced UI component framework for easily integrating Ajax capabilities into business applications using JSF.
- 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
- Simplified Framework Build
- Extensive Integration Testing
- Fast Development (CDK) & Test Turnaround
see Roadmap for more information.
| License | LGPL v2.1 |
| Build System | Maven |
- Documentation
- News / RSS
- includes release announcements
- Issue Tracker
- Roadmap
- User Forums
- IRC
#richfacesatirc.freenode.net
- Developer Forums
- Team Meetings
- Continuous Integration
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 namespace:
<!DOCTYPE html>
<html lang="en"
xmlns="http://www.w3.org/1999/xhtml"
...
xmlns:r="http://richfaces.org">
</html>
For more information on how to get started with the project, see Project Documentation.
$ git clone git@github.com:richfaces/richfaces.git
Prerequsities:
- JDK 1.6 +
- Maven 3.0.4 +
- JBoss Maven Repository
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.
$ mvn clean install -Prelease
the ZIP distribution will be stored in dist/target/.
Read How to Contribute.
All the sources related to RichFaces framework and component library are located in framework folder:
src/main/java- framework sources
- JSF components under
org.richfaces.uipackage
src/main/resources/META-INF/resources- JavaScript and CSS resources
Examples such as RichFaces Showcase and Components Demo are stored in examples folder.
Once you have built the project you can import framework and one of examples to the IDE.
If you are using Eclipse, you should use Import Existing Maven Project option.
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.
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=wildfly80 -Dsmoke
This will run the project tests against managed instance of WildFly 8.0 and test it on headless PhantomJS browser.
This step is also executed in the continuous integration job.