django-spa 0.2.0

Simple Django configuration to serve a single-page app

django-spa

Simple Django configuration to serve a single-page app (SPA).

The following SPA settings are handled in django-spa:

• index.html served on /

• all /static/... files served on /...

• Django’s urls still work (Django admin, templates, Django REST framework APIs)

• everything else goes to / for frontend routing (e.g. react-router)

Usage

First set up WhiteNoise, as django-spa overrides some of its functionality.

Add django-spa to your requirements.txt:

django-spa

Update settings.py with the django-spa middleware:

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'whitenoise.middleware.WhiteNoiseMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'spa.middleware.SPAMiddleware',
]

Use the django-spa static file storage:

STATICFILES_STORAGE = 'spa.storage.SPAStaticFilesStorage'

You should be good to go!

Credits

Used some parts of the solution suggested in this WhiteNoise issue for serving index.html on /. This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

License

MIT

History

0.2.0 (2017-09-01)

• Fix #3

0.1.1 (2017-04-08)

• Metadata fixes.

0.1.0 (2017-04-08)

• First release on PyPI.

• Initial django-spa middleware.