# qooxdoo - Open Source RIA Framework

Welcome to qooxdoo! It is easy to create your own rich internet applications. For detailed information please see the external documentation to get started.

For the impatient, here is a short version as well:
Use the `tool/bin/create-application.py` script to setup a new application. This will create a minimal directory structure of an application, which is ready to be built and run. Within the newly created application folder run the command
`generate.py source-all` to build a development version of your app. Open `source/index.html` in your browser and see your first application in action. You can then go on and extend it into an application of your liking by changing the `Application.js` class file below the `source/class/` folder.

Open the included API viewer to display and search the entire API reference of the framework.

Also have a look at the readme.txt and license.txt.

## Demo Applications

Please note that the following applications, besides the Showcase, are not pre-built. To create working applications locally use the appropriate commands `generate.py source` or `generate.py build`

- ### Showcase (Online)

  Highlights some of qooxdoo's main features and provides a good overview of what can be achieved.

  Source (needs generation)
  Build (ready to run)

- ### Demo Browser (Online)

  Contains many examples and tests for widgets, layouts and other framework functionality.

  Source | Build (both need generation)

- ### Playground (Online)

  Explore qooxdoo programming interactively: edit qooxdoo code in one pane, and see the result running in another.

  Source | Build (both need generation)

- ### Feed Reader (Online)

  A typical rich internet application (RIA) for displaying RSS feeds.

  Source | Build (both need generation)

- ### Portal (Online)

  A low-level, DOM-oriented application without any high-level qooxdoo widgets.

  Source | Build (both need generation)

## Developer Tools

The following applications work with data from the qooxdoo framework itself. Versions can also be generated that are specific to your custom application. While the API Viewer is pre-built and runs out-of-the-box, you need to generate the others yourself.

- ### API Viewer (Offline)

  Searchable API reference of the qooxdoo framework.

  Framework API (ready to run)

- ### Test Runner (Online)

  Integrated unit testing framework similar to (but not requiring) JSUnit.

  Framework Tests (needs generation)

- ### Inspector (Online)

  A debugging tool to inspect a qooxdoo application, featuring an interactive console, an object and widget finder, and a property editor.

  Inspector (needs generation)