Skip to main content

Simple Django configuration to serve a single-page app

Project description

django-spa

https://img.shields.io/pypi/v/django-spa.svg https://img.shields.io/travis/metakermit/django-spa.svg Documentation Status Updates

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 /...

  • 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',
    ]

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.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.1.1.tar.gz (14.1 kB view hashes)

Uploaded Source

Built Distribution

django_spa-0.1.1-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 2 Python 3

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