Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/escolalms/notifications

Main package of notification module which saves all notifications to database and allows to attach any other Template channels
https://github.com/escolalms/notifications

laravel notifications

Last synced: 4 days ago
JSON representation

Main package of notification module which saves all notifications to database and allows to attach any other Template channels

Host: GitHub
URL: https://github.com/escolalms/notifications
Owner: EscolaLMS
License: mit
Created: 2021-11-02T11:36:45.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-06-28T13:22:09.000Z (over 1 year ago)
Last Synced: 2024-10-29T00:57:32.056Z (17 days ago)
Topics: laravel, notifications
Language: PHP
Homepage:
Size: 23.4 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Notifications

Notifications package

[![swagger](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Notifications/)

[![codecov](https://codecov.io/gh/EscolaLMS/notifications/branch/main/graph/badge.svg?token=gBzpyNK8DQ)](https://codecov.io/gh/EscolaLMS/notifications)

[![phpunit](https://github.com/EscolaLMS/notifications/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/notifications/actions/workflows/test.yml)

[![downloads](https://img.shields.io/packagist/dt/escolalms/notifications)](https://packagist.org/packages/escolalms/notifications)

[![downloads](https://img.shields.io/packagist/v/escolalms/notifications)](https://packagist.org/packages/escolalms/notifications)

[![downloads](https://img.shields.io/packagist/l/escolalms/notifications)](https://packagist.org/packages/escolalms/notifications)

## 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](https://img.shields.io/badge/documentation-swagger-green)](https://escolalms.github.io/Notifications/)

## Tests

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

Test details:

[![codecov](https://codecov.io/gh/EscolaLMS/notifications/branch/main/graph/badge.svg?token=gBzpyNK8DQ)](https://codecov.io/gh/EscolaLMS/notifications)

[![phpunit](https://github.com/EscolaLMS/notifications/actions/workflows/test.yml/badge.svg)](https://github.com/EscolaLMS/notifications/actions/workflows/test.yml)

### Admin panel

#### **Left menu**

![Menu](docs/menu.png "Menu")

#### **List of notifications**

![List of notifications](docs/list.png "List of notifications")

## Permissions

Permissions are defined in [seeder](vendor/escolalms/notifications/database/seeders/NotificationsPermissionsSeeder.php)

## 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

- ???