caffeinated/shinobi

Laravel Roles and Permissions

v5.0.0 2019-09-06 01:23 UTC

README

Source Latest Stable Version License Total Downloads Travis (.org)

A simple and light-weight role-based permissions system for Laravel's Authorization Gate system.

  • Every user can have zero or more permissions.
  • Every user can have zero or more roles.
  • Every role can have zero or more permissions.
  • Every role can have one of two special flags, all-access and no-access

Documentation

You will find user friendly and updated documentation on the Caffeinated website.

Installation

Simply install the package through Composer. From here the package will automatically register its service provider and Shinobi facade.

composer require caffeinated/shinobi

Config

To publish the config file, run the following:

php artisan vendor:publish --provider="Caffeinated\Shinobi\ShinobiServiceProvider" --tag="config"

Changelog

You will find a complete changelog history within the CHANGELOG file.

Contributing

Please see CONTRIBUTING for details.

Testing

Run tests with PHPUnit:

vendor/bin/phpunit

Security

If you discover any security related issues, please email shea.lewis89@gmail.com directly instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.