Kauri 0.4 Documentation

Welcome to the Kauri documentation.

Check our documentation service for other releases and off-line/printable (e.g. pdf) Daisy-books.

First Experience

If this is your first visit and contact with the project you probably want to start off with either one of our introduction trails:

• Getting started will help you take the most basic steps to download and install Kauri for you, and follows up by showing the typical development setup. It ends with the generation of a hello-world sample project.  This is the shortest track to an environment for further self-exploration and toying around.
• The Step by step Tutorial takes a more guided approach. And while we do recommend trying out all the steps along the way on an installed Kauri, you might choose to just read it through to get a better feel of what this is all about.

The core

• The modular approach in the Kauri Runtime is best introduced through this bit of Essential Kauri theory
• Which is further deepened by getting a understanding of how the routing works.
• The configuration section explains how dev-ops folks should separate application building from environmental setup.

After these you should be set to integrate whatever back-end system into your own module to effectively disclose it via your own REST-full interface. For 'classic' RDBMS stuff, you will find some inspiration in the section on JPA database resources.

Front-end development

Bridging the gap from web-service to web-sites these sections are recommended:

• The Prototyping section offers an approach that allows front- and back-end developers to collaborate in parallel rather then consecutively on the same project.
• From there you'll find natural links into the technical details for building display (templates) and interactivity (forms) screens.
• The Representation builder shows how an MVC like model is supported on top of the previous techniques.

Miscellaneous Modules

A number of typical non-functional requirements in web development get their special attention here:

• Internationalization (i18n)
• Security

As well as a practical approach to the issue of dealing with Temporary Resources in a REST oriented environment.

Deployment and Administration 

Towards deployment the relevant sections are those about:

• Packaging Kauri applications
• Service wrapper

Revisiting the  configuration section might make sense as well.

Reference Sections

Most of the sections mentioned above have detailed explanations on exact use (included detailed syntax samples) at the end. This list just helps you access those reference sub-sections directly:

• wiring.xml reference
• Routing reference
• Configuration reference
• Template Syntax reference
• Forms reference