dpw

django-progressive-web-app

Looks like an app, feels like an app, but NOT an app.

Showing:

Popularity

Downloads/wk

0

GitHub Stars

93

Maintenance

Last Commit

3yrs ago

Contributors

4

Package

Dependencies

0

License

MIT License

Categories

Readme

DEPRECATED: @silviolleite has been kind enough to build on this initial implementation and add some excellent functionality. You can find his supported implementation of this project here: https://github.com/silviolleite/django-pwa

Silvio has also published it to PyPI: https://pypi.org/project/django-pwa/

django-progressive-web-app

This Django app turns your project into a progressive web app. Navigating to your site on an Android phone will prompt you to add the app to your home screen.

Prompt for install

Launching the app from your home screen will display your app without browser chrome. As such, it's critical that your application provides all navigation within the HTML (no reliance on the browser back or forward button).

Requirements

Progressive Web Apps require HTTPS unless being served from localhost. If you're not already using HTTPS on your site, check out Let's Encrypt and ZeroSSL.

Installation

Install from PyPI:

pip install django-progressive-web-app

Configuration

Add pwa to your list of INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    ...
    'pwa',
    ...
]

Configure your app name, description, and icons in settings.py:

PWA_APP_NAME = 'My Kickass App'
PWA_APP_DESCRIPTION = "Do kickass things all day long without that pesky browser chrome"
PWA_APP_THEME_COLOR = '#0A0302'
PWA_APP_BACKGROUND_COLOR = '#ffffff'
PWA_APP_DISPLAY = 'standalone'
PWA_APP_START_URL = '/'
PWA_APP_ICONS = [
    {
        'src': '/static/images/my_app_icon.png',
        'sizes': '160x160'
    }
]

All settings are optional, and the app will work fine with its internal defaults. Highly recommend setting at least PWA_APP_NAME and PWA_APP_DESCRIPTION.

Add the progressive web app URLs to urls.py:

from django.conf.urls import url, include

urlpatterns = [
    ...
    url('', include('pwa.urls')),  # You MUST use an empty string as the URL prefix
    ...
]

Inject the required meta tags in your base.html (or wherever your HTML <head> is defined):

{% load pwa %}

<head>
    ...
    {% progressive_web_app_meta %}
    ...
</head>

Troubleshooting

While running the Django test server:

  1. Verify that /manifest.json is being served
  2. Verify that /serviceworker.js is being served
  3. Use the Application tab in the Chrome Developer Tools to verify the progressive web app is configured correctly.
  4. Use the "Add to homescreen" link on the Application Tab to verify you can add the app successfully.

Adding Your Own Service Worker

By default, the service worker implemented by this app is empty. To add service worker functionality, you'll want to create a serviceworker.js or similarly named file, and then point at it using the PWA_SERVICE_WORKER_PATH variable.

PWA_SERVICE_WORKER_PATH = os.path.join(BASE_DIR, 'my_app', 'serviceworker.js')

Feedback

I welcome your feedback and pull requests. Enjoy!

License

All files in this repository are distributed under the MIT license.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial