zerosonesfun/pwa

This package is abandoned and no longer maintained. The author suggests using the askvortsov/flarum-pwa package instead.

A Progressive Web App extension.

Maintainers

Details

github.com/zerosonesfun/pwa

Source

Issues

Installs: 732

Dependents: 0

Suggesters: 0

Security: 0

Stars: 9

Watchers: 1

Forks: 5

Open Issues: 0

Language:HTML

Type:flarum-extension

1.3 2020-03-07 08:32 UTC

Requires

MIT 4448a101eab0005af2ba2d5959b77fd2cd26b54c

  • Billy Wilcosky

This package is auto-updated.

Last update: 2020-05-09 08:19:28 UTC

README

Turns Flarum into a basic progressive web app. If a user loses connection, an offline page will appear with a simple message alerting them that this app does not work offline. As of version 1.1, this PWA no longer attempts to cache pages. This is because it was discovered that, in certain browsers / on certain devices, the extra caching was causing users to have to manually refresh pages in order to complete tasks such as logging out or logging in. However, even without caching this is useful because it gives users another option: the ability to install your forum and open it in a standalone app window.

This is what you see and how to install in Chrome (on a desktop). Each browser and device will handle this differently.

Install instructions

Pre-install:

  1. Required: Add sw.js to the public root of your site (i.e. /public_html/, /home/, or whatever your public root is called).
  2. Required: Add site.webmanifest to the public root of your site (/public_html/, /home/, or whatever your public root is called).
  3. Optional: Edit the site.webmanifest file. Change the name of the app, where the app icons are located, and even the theme color and background color settings. Do not change the start url or scope unless you know what you're doing.

Install:

  1. composer require zerosonesfun/pwa

Update:

composer update zerosonesfun/pwa

Links: