############
Demo project
############

Django-formrenderingtools sourcecode contains a demonstration project in the
demo/ folder.

This project is a demo for the django-formrenderingtools package. Use it to
quickly see, understand and experiment Django-formrenderingtools concepts.

The demo produces a presentation of django-formrenderingtools usage with
examples.

Install
=======

Check requirements. This demo requires the following software to be installed
on your system:

* Python >= 2.6 ("with" statement in setup.py)
* Virtualenv
* Mercurial (if unavailable, download and extract the source from bitbucket
  manually)

With buildout
-------------

.. code-block:: bash

  # Get the source
  hg clone http://bitbucket.org/benoitbryon/django-formrenderingtools
  # Optional but recommended: create a virtual environment
  virtualenv --distribute --no-site-packages django-formrenderingtools
  source django-formrenderingtools/bin/activate
  # Installation with buildout
  cd django-formrenderingtools
  bin/python bootstrap.py -d
  bin/buildout
  # You can run the tests!
  bin/test

If everything went fine, you have a buildout environment and can test the 
application.

With Virtualenv and pip
-----------------------

.. code-block:: bash

  # Clone Django-formrenderingtools (or download and extract it):
  hg clone http://bitbucket.org/benoitbryon/django-formrenderingtools
  # Create a virtual environment and activate it:
  virtualenv --no-site-packages --distribute django-formrenderingtools
  source django-formrenderingtools/bin/activate
  # Installation with pip
  cd django-formrenderingtools
  bin/pip install -r requirements.txt
  # You can run the tests!
  bin/python demo/manage.py test formrenderingtools

Look at the demo
================

* Activate the virtual environment if necessary
* Run the development server (buildout installation):
  ::

    bin/django runserver

  Or (virtualenv/pip installation):
  ::
  
    bin/python demo/manage.py runserver

* Open http://localhost:8000/ in your browser.
* Read the sourcecode in the demo/ folder of your django-formrenderingtools
  installation.

Experiment
==========

Use this demo project as a sandbox!

Demo is part of the development process
=======================================

The demo project is part of the documentation. It has been created to help
developers discover the application. It explains real-world usage.

The demo project is also intended to become part of the tests.
