Skip to main content

Simple Django configuration to serve a single-page app

Project description

django-spa

https://badge.fury.io/py/django-spa.svg https://travis-ci.org/metakermit/django-spa.svg?branch=master Documentation Status Updates GitHub license

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

The following settings that make serving SPAs easier are handled in django-spa:

  • index.html served when / requested

  • all /static/… files served on /… as well

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

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

Usage

For an example of using django-spa to serve a create-react-app frontend that consumes a Django REST framework API, check out generator-django-rest.

As part of setting up django-spa, you also need to set up WhiteNoise, which we’ll summarise here.

First, add django-spa to your requirements.txt and pip install -r requirements.txt (or pipenv install django-spa). Whitenoise is installed as a dependency, so no need to specify it extra.

Update settings.py with the Whitenoise & django-spa middleware:

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'whitenoise.middleware.WhiteNoiseMiddleware',
    'spa.middleware.SPAMiddleware',
    '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',
]

Disable runserver’s static file serving by adding runserver_nostatic to the top of your INSTALLED_APPS list:

INSTALLED_APPS = [
    'whitenoise.runserver_nostatic',
    'django.contrib.staticfiles',
    # ...
]

Set 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.3.0 (2019-12-15)

  • add example project

  • support Django 3.0

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-spa-0.3.6.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

django_spa-0.3.6-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-spa-0.3.6.tar.gz.

File metadata

  • Download URL: django-spa-0.3.6.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.7

File hashes

Hashes for django-spa-0.3.6.tar.gz
Algorithm Hash digest
SHA256 fc09eb0dd0b296bd4c4fcaa8fb7715f363ed385bc2446a6dcb4ee57b1b7027d5
MD5 7a1dee929c0e1c10f4a2da13807d612e
BLAKE2b-256 f6e4c4a40c3adf8e3837a41e92acc47c79fd797a850fcd6776570be292bc8e62

See more details on using hashes here.

File details

Details for the file django_spa-0.3.6-py2.py3-none-any.whl.

File metadata

  • Download URL: django_spa-0.3.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.7

File hashes

Hashes for django_spa-0.3.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b3eff51e4edfb046a5293e73ad0e3105f0ee654873b42bae172178acc47ad450
MD5 b14c734c4a8c5db26b34a39c5d78a75d
BLAKE2b-256 20951f1d5e8efb4d8597f9e3d6160c22c6fd9ec43c0ea258eba085f1eb8120c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page