escolalms / bulk-notifications
Escola Headless LMS Bulk Notifications
Installs: 1 253
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:package
Requires
- php: >=7.4
- escolalms/auth: ^0
- escolalms/core: ^1
- escolalms/settings: ^0
- kreait/laravel-firebase: >=4
- laravel/framework: >=8.0
Requires (Dev)
- darkaonline/l5-swagger: 8.1.0
- escolalms/courses: ^0.4
- orchestra/testbench: >=5.0
- phpunit/phpunit: ^9.0
README
What does it do
This package is used to send bulk notifications through various channels. The available channels are PushNotification.
PushNotifications
Sending push notifications is through FCM (Firebase Cloud Messaging). Push messages can be sent to a list of users or to all users of the system. Messages are sent to registered FCM tokens.
Installing
composer require escolalms/bulk-notifications
php artisan migrate
php artisan db:seed --class="EscolaLms\BulkNotifications\Database\Seeders\BulkNotificationPermissionSeeder"
Configuration
The config.php configuration file is divided into channels.
For the push channel, you can configure:
service_account
- FCM access keybase_redirect_url
- base url set in notifications for the redirect_url field
[ 'push' => [ 'service_account' => [], 'base_redirect_url' => null ] ];
Endpoints
All the endpoints are defined in swagger
Events
NotificationSent
- The notification has been created.
The event is listened to by the escolalms/notifications package.
Permissions
Permissions are defined in seeder