==============
django-backend
==============

|build-status|

Installation
============

Add the following apps to your ``INSTALLED_APPS`` settings:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'django.contrib.auth',
        'django.contrib.sites',
        'django.contrib.staticfiles',
        ...
        'django_backend',
        'django_ajax',
        'django_assets',
        'floppyforms',
    )

Add the following line to your ``urls.py``:

.. code-block:: python

    url(r'^backend/', include(django_backend.site.get_urls(), namespace='django_backend')),

TODO: continue, propably not complete yet

Development
===========

Run tests
---------

.. code-block:: bash

    # Set everything up. You want to do this in a virtualenv.
    pip install -r tests/requirements.txt
    python setup.py develop

    # Run the tests. Should be executed in the root of the project.
    py.test

.. |build-status| image:: https://travis-ci.org/team23/django_backend.svg
    :target: https://travis-ci.org/team23/django_backend

==============
django-backend
==============

|build-status|

Installation
============

Add the following apps to your ``INSTALLED_APPS`` settings:

.. code-block:: python

    INSTALLED_APPS = (
        ...
        'django.contrib.auth',
        'django.contrib.sites',
        'django.contrib.staticfiles',
        ...
        'django_backend',
        'django_ajax',
        'django_assets',
        'floppyforms',
    )

Add the following line to your ``urls.py``:

.. code-block:: python

    url(r'^backend/', include(django_backend.site.get_urls(), namespace='django_backend')),

TODO: continue, propably not complete yet

Development
===========

Run tests
---------

.. code-block:: bash

    # Set everything up. You want to do this in a virtualenv.
    pip install -r tests/requirements.txt
    python setup.py develop

    # Run the tests. Should be executed in the root of the project.
    py.test

.. |build-status| image:: https://travis-ci.org/team23/django_backend.svg
    :target: https://travis-ci.org/team23/django_backend

Build static assets
-------------------

.. code-block:: bash

    npm install
    gulp build

    # Use gulp watch to continuously build on source file changes.
    gulp watch

Or to create a development build that includes source maps, execute the ``dev`` task first, like:

.. code-block:: bash

    gulp dev build

Add readme about gulp builds
Add readme about gulp builds
