carkii/notifier

notifier

Notifier is a laravel library that helps you to popup notifications to your registered users., _(*1)

requirements

1- Jquery, _(*2)

How to install ?

• Composer: type composer require carkii/notifier

configaration (provider & alias)

in config\app.php, add notifier service provider :, _(*3)

'providers' => [
    /*  
    //
    other providers
    //
    */
    Carkii\Notifier\NotifierServiceProvider::class,
  ]

and add aliase to same file:, _(*4)

'aliases' => [
    /*  
    //
    other aliases
    //
    */
    'Notifier' => Carkii\Notifier\facades\Notifier::class,
  ]

publish

publish the required files by typing php artisan vendor:publish in terminal., _(*5)

This will add the following to your project:, _(*6)

1- /config/notifier.php, _(*7)

2- /resources/views/notifications/_cardExample.blade.php, _(*8)

3- /resources/views/notifications/_ModalExample.blade.php, _(*9)

4- /public/css/notifications.css, _(*10)

5- /public/js/notifications.js, _(*11)

migrate notifications table

in your terminal, type : php artisan migrate, _(*12)

Note: this library supposed that you already migrated the users table under users name in your database., _(*13)

add CSRF_token

add CSRF_token to your head tag, add: php <meta name="csrf-token" content="{{ csrf_token() }}"> to your , _(*14)

How to use?

## 1- Modal (popup) 1- login in to your website, _(*15)

2- add the following at the end of your page (default: app.blade.php):, _(*16)

php {!! Notifier::break(0,30,0)->get()->first() !!} {!! Notifier::addStylesAndScriptes() !!}, _(*17)

3- remove the first underscore (_) from /resources/views/notifications/_ModalExample.blade.php to be as /resources/views/notifications/ModalExample.blade.php. (this example is using bootstrap), _(*18)

Note:, _(*19)

- break($days,$hours,$minutes) is used to add a break time between notifications.

- the first underscore of your notification file tells Notifier to ignore this file.

- All of your notifications are located in ```/resources/views/notifications/```, each notification in each file (blade template) So, whenever you add a file to this folder, it means you are adding a new notification to your list.

4- visit your website :), _(*20)

2- Card (list of notifications)

1- login in to your website, _(*21)

2- add the following to your page (default: app.blade.php, recommended in navbar):, _(*22)

```php // get list of notifications and diaply them as a list // navbar

//end of your page's body {!! Notifier::addStylesAndScriptes() !!} ```, <sub>(*24)</sub>

3- remove the first underscore (_) from /resources/views/notifications/_CardExample.blade.php to be as /resources/views/notifications/CardExample.blade.php. (this example is using bootstrap), <sub>(*25)</sub>

4- visit your website :), <sub>(*26)</sub>