Metadata-Version: 1.1
Name: django-spa
Version: 0.2.0
Summary: Simple Django configuration to serve a single-page app
Home-page: https://github.com/metakermit/django-spa
Author: Dražen Lučanin
Author-email: kermit666@gmail.com
License: MIT license
Description: ===============================
        django-spa
        ===============================
        
        
        .. image:: https://img.shields.io/pypi/v/django-spa.svg
                :target: https://pypi.python.org/pypi/django-spa
        
        .. image:: https://img.shields.io/travis/metakermit/django-spa.svg
                :target: https://travis-ci.org/metakermit/django-spa
        
        .. image:: https://readthedocs.org/projects/django-spa/badge/?version=latest
                :target: https://django-spa.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        .. image:: https://pyup.io/repos/github/metakermit/django-spa/shield.svg
             :target: https://pyup.io/repos/github/metakermit/django-spa/
             :alt: 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 ``/...``
        * 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_
        
        .. _Whitenoise: https://github.com/evansd/whitenoise/
        .. _`Whitenoise issue`: https://github.com/evansd/whitenoise/issues/12
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        .. _`react-router`: https://reacttraining.com/react-router/
        .. _MIT: LICENSE
        
        
        =======
        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.
        
Keywords: django spa django-spa react angular yeoman heroku
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
