django-downloadview/demo
2012-12-04 12:21:45 +01:00
..
demoproject Improved demo project: provided initial data and a simple homepage with some links. 2012-12-04 12:21:45 +01:00
README Reviewed documentation. Preparing first public release. 2012-12-04 11:47:37 +01:00
setup.py Improved testing. Fixed 'make documentation'. 2012-08-27 18:27:00 +02:00

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

The :file:`demo/` folder holds a demo project to illustrate (and test)
django-downloadview usage.


***********************
Browse demo code online
***********************

See `demo folder in project's repository`_.


***************
Deploy the demo
***************

System requirements:

* `Python`_ version 2.6 or 2.7, available as ``python`` command.
  
  .. note::

     You may use `Virtualenv`_ to make sure the active ``python`` is the right
     one.

* ``make`` and ``wget`` to use the provided :file:`Makefile`.

Execute:

.. code-block:: sh

   git clone git@github.com:benoitbryon/django-downloadview.git
   cd django-downloadview/
   make demo

It installs and runs the demo server on localhost, port 8000. So have a look
at http://localhost:8000/

.. note::

   If you cannot execute the Makefile, read it and adapt the few commands it
   contains to your needs.

Browse and use :file:`demo/demoproject/` as a sandbox.


**********
References
**********

.. target-notes::

.. _`demo folder in project's repository`:
   https://github.com/benoitbryon/django-downloadview/tree/master/demo/demoproject/

.. _`Python`: http://python.org
.. _`Virtualenv`: http://virtualenv.org