README

Introduction
------------

Skeleton setup to quickly start a `Django`_ project.


Installation
------------

Install requirements:

    * `Git`_ 
    * `Subversion`_
    * `Fabric`_
    * `pip`_
    * `Virtualenv`_ 
    * `Virtualenvwrapper`_
    
Clone the project::

    $ git clone git://github.com/gillesfabio/django-newproject.git

This will create ``django-newproject`` directory in your current directory.


Create a project
----------------

Launch ``newproject`` Fabric task::

    $ cd django-newproject
    $ fab newproject

The script will ask you some questions.
    
Go in the project's directory and active the virtualenv::

    $ cd /path/to/your/project
    $ workon yourproject 


Customization
-------------

The default configuration for a "standard" Django project (not a Google App
Engine one) uses ``sqlite3`` database backend. The database file
is stored in ``db/development.sqlite``.

If this does not suit your needs, edit ``settings_local.py``. 

Edit these files as necessary:

    * ``settings.py``
    * ``urls.py``
    * ``requirements-prod.txt``
    * ``requirements.txt``
    * ``templates/layout/base.html``

Then, synchronize the database and run the server::

    $ python manage.py syncdb
    $ python manage.py runserver

That's all. Have fun!


.. _Django: http://djangoproject.com/
.. _Git: http://git-scm.org/
.. _Subversion: http://subversion.tigris.org/
.. _Fabric: http://fabfile.org/
.. _pip: http://pypi.python.org/pypi/pip
.. _Virtualenv: http://pypi.python.org/pypi/virtualenv
.. _Virtualenvwrapper: http://pypi.python.org/pypi/virtualenvwrapper