Skip to content

👺 Laravel 5 roles and permissions package with support for Laravel's authentication contract.

License

Notifications You must be signed in to change notification settings

jamesbrauman/shinobi

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Caffeinated Shinobi

Laravel 5.0 Laravel 5.1 Source Build Status 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 here: Shinobi Documentation

Quick Installation

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

Laravel 5.0.x

composer require caffeinated/shinobi=~1.0

Laravel 5.1.x

composer require caffeinated/shinobi=~2.0

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

Laravel 5.0.x

'Caffeinated\Shinobi\ShinobiServiceProvider'

Laravel 5.1.x

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

About

👺 Laravel 5 roles and permissions package with support for Laravel's authentication contract.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%