Table of contents

  1. Purpose
  2. Requirements
  3. Get started
  4. The structure
  5. The RIFE project

A. Purpose

This package is meant as a demonstration of RIFE/Crud and also to provide you with a fully working self-contained example aplication that you can use to start experimenting with.

Everything is set up to provide you with a comfortable development structure and to make the packaging of your work as easy as possible.

Note that you should never apply this setup to a production environment since it's only applicable in cases where there's only one application running inside a servlet container.

table of contents

B. Requirements

These requirements need to be fulfilled before you can get started immediately:

Please refer to the documentation of these tools to get them installed correctly on your machine.

It's possible to use any development tool. The ones above been selected since they are the most common and make it possible to easily distribute a working machine-independent project configuration.

table of contents

C. Get started

By following the steps below you'll quickly be able to test a small sample application with your development environment of choice.

1. Apache Ant 1.6

2. X-develop 2.0

3. IntelliJ IDEA 6.0

4. NetBeans 5.5

5. Eclipse 3.2

table of contents

D. The structure

The application's sources

src

The element implementations that provide view or business logic to the elements.

Java source code that provides back-end logic.

resources
 |
 +- rep

The rep.xml file that sets up the repository and all the XML files that are required by the participants that are started.

 |
 +- sites

The site structures that define the logic flow and data flow of your application.

 |
 +- elements

The element declarations that are used in the site structures.

These are only needed if you want to reuse elements through XML declarations.

The current jumpstart doesn't use these but rather include the element declarations inside the actual site structures.

 |
 +- templates

The templates that are used by the implementations to output content to the user.

Website files

web
 |
 +- WEB-INF

The web application directory.

 |
 +- images

The images that are used by the templates.

 |
 +- style

The CSS stylesheets that are used by the templates.

The application's libraries

lib

table of contents

E. The RIFE project

The downloads are available at File sharing.

The examples can be tried online at http://rifers.org/examples.

The users guide can be read online at http://rifers.org/docs/usersguide.

The API documentation can be read online at http://rifers.org/docs/api.

The issue-tracker is available at http://servlet.uwyn.com/issues.

The wiki is available at http://rifers.org/wiki.

The mailinglists are set up at UWYN, the following are available:

Real-time chatting about RIFE can be done through IRC at irc.freenode.net in the channel #rife.