README

A Flarum extension that lets users install your forum as an app, adding a shortcut to their home screen or desktop. It also adds push notification support. Configure both from your admin dashboard.

Installation

composer require fof/pwa

Updating

composer update fof/pwa

For Developers

Extending the manifest

Customize the manifest in your extension's or forum's extend.php:

use Flarum\Extend;
use FoF\PWA\Extend as PwaExtend;

return [
    (new Extend\Conditional())
        ->whenExtensionEnabled('fof-pwa', fn () => [
            (new PwaExtend\Manifest())
                ->modify(function (array $manifest): array {
                    $manifest['categories'] = ['social'];
                    return $manifest;
                }),
        ]),
];

Callbacks receive the completed manifest and must return the modified array. They run in registration order and also apply to the admin preview. modify() also accepts an invokable class with constructor dependency injection.

Credit

Billy Wilcosky – for starting PWA support for Flarum.
Alexander Skvortsov – for reviving and expanding the extension with push notification support.
FriendsOfFlarum – current maintainers.

fof / pwa

Package info

Security

Fund package maintenance!

Statistics