bentools/webpush-bundle

Symfony Bundle: Associate your users to webpush subscriptions.

, _(*1)

Webpush Bundle

This bundle allows your app to leverage the Web Push protocol to send notifications to your users' devices, whether they're online or not., _(*2)

With a small amount of code, you'll be able to associate your Symfony users to WebPush Subscriptions:, _(*3)

• A single user can subscribe from multiple browsers/devices
• Multiple users can subscribe from a single browser/device

This bundle uses your own persistence system (Doctrine or anything else) to manage these associations., _(*4)

We assume you have a minimum knowledge of how Push Notifications work, otherwise we highly recommend you to read Matt Gaunt's Web Push Book., _(*5)

Example Use cases, _(*6)

• You have a todolist app - notify users they're assigned a task
• You have an eCommerce app:
  • Notify your customer their order has been shipped
  • Notify your category manager they sell a product

Summary

1. Installation
2. The UserSubscription entity
3. The UserSubscription manager
4. Configure the bundle
5. Enjoy!
6. F.A.Q.

Getting started

This bundle is just the back-end part of the subscription process. For the front-end part, have a look at the webpush-client package., _(*7)

Composer is your friend:

PHP8.1+ is required., _(*8)

composer require bentools/webpush-bundle

⚠️ We aren't on stable version yet - expect some changes., _(*9)

Generate your VAPID keys:

php bin/console webpush:generate:keys

You'll have to update your config with the given keys. We encourage you to store them in environment variables or in parameters.yml., _(*10)

Next: Create your UserSubscription class, _(*11)

Tests

./vendor/bin/phpunit, _(*12)

License

MIT, _(*13)

Credits

This bundle leverages the minishlink/web-push library., _(*14)