escolalms/notifications

Escola LMS Notifications

Maintainers

πŸ‘ qunabu

Package info

github.com/EscolaLMS/Notifications

Type:package

pkg:composer/escolalms/notifications

Statistics

Installs: 50 056

Dependents: 3

Suggesters: 0

Stars: 0

Open Issues: 0

0.3.2 2023-06-28 13:20 UTC

Requires

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT ad14133686ad53515d16c8ab4bcc3b8fc0bef21c

  • PaweΕ‚ ChoΕ‚aj <pawel.cholaj.woop@escolasoft.com>

README

Notifications package

πŸ‘ swagger
πŸ‘ codecov
πŸ‘ phpunit
πŸ‘ downloads
πŸ‘ downloads
πŸ‘ downloads

What does it do

This package is used for logging and broadcasting notifications for all EscolaLms packages events.

Installation

  • composer require escolalms/notifications
  • php artisan migrate
  • php artisan db:seed --class="EscolaLms\Notifications\Database\Seeders\NotificationsPermissionsSeeder"

Usage

All events emitted by EscolaLms packages will be logged in database and can be listed through API (and Admin Panel). There is a configuration file in which you can define events which should be excluded from being stored.

Endpoints

All the endpoints are defined in πŸ‘ swagger

Tests

Run ./vendor/bin/phpunit --filter 'EscolaLms\\Notifications\\Tests' to run tests. See tests folder as it's quite good staring point as documentation appendix.

Test details: πŸ‘ codecov
πŸ‘ phpunit

Admin panel

Left menu

πŸ‘ Menu

List of notifications

πŸ‘ List of notifications

Permissions

Permissions are defined in seeder

Events

No Events are defined in this package.

Listeners

  • EscolaLms\Notifications\Listeners\NotifiableEventListener - this listener listens to all events in EscolaLms namespace

Roadmap. Todo. Troubleshooting

  • ???