README

Notifynder is designed to manage notifications in a powerful and easy way. With the flexibility that Notifynder offer, It provide a complete API to work with your notifications, such as storing, retrieving, and organise your codebase to handle hundreds of notifications. You get started in a couple of minutes to "enable" notifications in your Laravel Project.

Compatible DBs: MySQL - PostgreSQL - SQLite

Documentation: Notifynder Docu

Installation

Step 1

Add it on your composer.json

"fenos/notifynder": "^4.0"

and run

composer update

or run

composer require fenos/notifynder

Step 2

Add the following string to config/app.php

Providers array:

Fenos\Notifynder\NotifynderServiceProvider::class,

Aliases array:

'Notifynder' => Fenos\Notifynder\Facades\Notifynder::class,

Step 3

Migration & Config

Publish the migration as well as the configuration of notifynder with the following command:

php artisan vendor:publish --provider="Fenos\Notifynder\NotifynderServiceProvider"

Run the migration

php artisan migrate

Senders

A list of official supported custom senders is in the Notifynder Doc.

We also have a collect issue for all additional senders we plan or already have.

If you want any more senders or want to provide your own please create an issue.

ToDo

Tasks we still have to do:

add unittests for parser and models
complete the new documentation

Versioning

Starting with v4.0.0 we are following the Semantic Versioning Standard.

Summary

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release (alpha, beta, rc) are available as extensions to the MAJOR.MINOR.PATCH format.

Contributors

Thanks for everyone who contributed to Notifynder and a special thanks for the most active contributors

Gummibeer

fenos/notifynder

包简介

关键字：

README 文档