django-backend

Note

This module can be imported in python with the name django_backend. The PyPI package is called django-admin-backend though. We had to use a different name as django-backend was already registered on PyPI. It's a little unfortunate this way, but a necessary workaround for now.

Installation

Add the following apps to your INSTALLED_APPS settings:

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

Make sure SITE_ID is set:

SITE_ID = 1

Make sure LANGUAGE_CODE is valid:

LANGUAGE_CODE = 'en'

Warning: Django's default language code is not valid, as "en-us" is not included in settings.LANGUAGES.

Add the following code to hook up the backend urls in your urls.py:

import django_backend
# ...

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

TODO: continue, propably not complete yet

Examples

A good way to get a feel about how django_backend can be used, is to have a look at the examples in the examples/ directory of this project. The examples are working django projects that you are able to run and play around with.

Have a look at the examples, they all have a separate README that describes how to setup them up and get started.

Development

Run tests

# 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 static assets

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:

gulp dev build