👺 Simple and light-weight role-based permissions system for Laravel's built in Auth system.
PHP
Clone or download
bretto36 and kaidesu Added Config Option to run migrations (#78)
* Added Config Option to run migrations

* Added default option

* Added publishes commands

* Moved config as per other engineers advice

* Moved config files
Latest commit c474f82 May 17, 2018

README.md

Caffeinated Shinobi

Laravel 5.5 Source License

Shinobi brings a simple and light-weight role-based permissions system to Laravel's built in Auth system. Shinobi brings support for the following ACL structure:

  • Every user can have zero or more roles.
  • Every role can have zero or more permissions.

Permissions are then inherited to the user through the user's assigned roles.

The package follows the FIG standards PSR-1, PSR-2, and PSR-4 to ensure a high level of interoperability between shared PHP code. At the moment the package is not unit tested, but is planned to be covered later down the road.

Documentation

You will find user friendly documentation in the wiki here: Caffeinated Shinobi Wiki

Quick Installation

Begin by installing the package through Composer. The best way to do this is through your terminal via Composer itself:

composer require caffeinated/shinobi

Once this operation is complete, simply add the service provider to your project's config/app.php file and run the provided migrations against your database.

Service Provider

Caffeinated\Shinobi\ShinobiServiceProvider::class

Migrations

You'll need to run the provided migrations against your database. Publish the migration files using the vendor:publish Artisan command and run migrate:

php artisan vendor:publish
php artisan migrate

Awesome Shinobi

See what the awesome community behind Shinobi has built. Created something you'd like added? Send a pull-request or open an issue!

Open Source