Add required repository

The details for the JBoss repository need to be added to Maven so it can access the archetype. Add a profile in the maven_installation_folder/conf/settings.xml file under the <profiles> element:

<profiles>

    ...

    <profile>

        <id>jboss-public-repository</id>

        <repositories>

            <repository>

                <id>jboss-public-repository-group</id>

                <name>JBoss Public Maven Repository Group</name>

                <url>https://repository.jboss.org/nexus/content/groups/public/</url>

                <layout>default</layout>

                <releases>

                    <enabled>true</enabled>

                    <updatePolicy>never</updatePolicy>

                </releases>

                <snapshots>

                    <enabled>true</enabled>

                    <updatePolicy>never</updatePolicy>

                </snapshots>

            </repository>

        </repositories>

        <pluginRepositories>

            <pluginRepository>

                <id>jboss-public-repository-group</id>

                <name>JBoss Public Maven Repository Group</name>

                <url>https://repository.jboss.org/nexus/content/groups/public/</url>

                <layout>default</layout>

                <releases>

                    <enabled>true</enabled>

                    <updatePolicy>never</updatePolicy>

                </releases>

                <snapshots>

                    <enabled>true</enabled>

                    <updatePolicy>never</updatePolicy>

                </snapshots>

            </pluginRepository>

        </pluginRepositories>

    </profile>

</profiles>

The profile then needs to be activated in the <activeProfiles> element:

<activeProfiles>

   <activeProfile>jboss-public-repository</activeProfile>

</activeProfiles>

For further details, refer to the JBoss RichFaces Wiki.

Generate the project from the archetype

The project can now be generated with the richfaces-archetype-simpleapp archetype. Create a new directory for your project, then run the following Maven command in the directory:

mvn archetype:generate -DarchetypeGroupId=org.richfaces.archetypes -DarchetypeArtifactId=richfaces-archetype-simpleapp -DarchetypeVersion=4.0.0-SNAPSHOT -DgroupId=org.docs.richfaces -DartifactId=new_project

The following parameters can be used to customize your project:

The command generates a new RichFaces project with the following structure:

new_project
	├── pom.xml
	├── readme.txt
	└── src
		└── main
		    ├── java
		    │   └── org
		    │       └── docs
		    │           └── richfaces
		    │               └── RichBean.java
		    └── webapp
		        ├── index.xhtml
		        ├── templates
		        │   └── template.xhtml
		        └── WEB-INF
		            ├── faces-config.xml
		            └── web.xml

Add test dependencies (optional)

Your root directory of your project contains a project descriptor file, pom.xml. If you wish to include modules for test-driven JSF development, add any dependencies for the tests to the pom.xml file.

Build the project

Build the project from the command line by entering the mvn install command.

The BUILD SUCCESSFUL message indicates the project has been assembled and is ready to import into an IDE (integrated development environment), such as JBoss Tools.

Import the project into an IDE

To import the project into Eclipse and JBoss Tools, use the JBoss Maven Integration plug-ins. These plug-ins work with plug-ins from the M2Eclipse project to import Maven projects.

1. Install the plug-ins

   1. Choose Help → Install New Software from the Eclipse menu.

   2. Select the JBoss Tools update site to use, then open the Maven Support group and select the JBoss Maven Integration and JBoss Maven JSF Configurator plug-ins.

   3. Follow the prompts to install the integration plug-ins. The installation will automatically include the transitive dependencies Maven Integration for Eclipse and Maven Integration for WTP. Both of these dependencies are from the M2Eclipse project.

   4. Restart Eclipse to finish the installation.

2. Open the importing wizard

   With the plug-ins installed, open the importing wizard by choosing File → Import from the menu.

3. Select the project

   Select Maven → Existing Maven Projects as the import source and choose the directory with the pom.xml file for your project.