askvortsov/flarum-pwa

Turn your flarum site into a progressive web app!

v3.4.0 2024-04-13 19:02 UTC

Requires

• flarum/core: ^1.7
• kreait/firebase-php: ^7.9
• minishlink/web-push: ^7.0
• spomky-labs/base64url: ^2.0

Requires (Dev)

• flarum/phpstan: ^1.0

Suggests

• ext-gmp: This can improve push notification performance.

MIT

• Alexander Skvortsov

• flarum

README

A Flarum extension. Progressive Web App support for Flarum. Configure a progressive web app for your flarum installation, all from your admin dashboard! Also now supports push notifications!

Please see resources like https://medium.com/pynk/what-is-a-pwa-and-how-to-install-add-to-home-screen-progressive-web-apps-e6e8087d9ad0 for more information on how to install this.

Credit

Thank you to Billy Wilcosky (https://github.com/zerosonesfun) for starting PWA support for Flarum. This extension uses his original ServiceWorker and offline html page code.

His original Discuss thread has been linked here: https://discuss.flarum.org/d/21487-pwa-progressive-web-app

TODO

• Verify Support for subdirectory installations
• Caching and expanded offline support
• Support configuration of ALL webmanifest attributes, especially:
  • Related Applications
  • Categories
  • Language
• Bugfixes and minor improvements

Installation

Use Bazaar or install manually with composer:

composer require askvortsov/flarum-pwa

Updating

composer update askvortsov/flarum-pwa

Links

• Packagist
• Github