Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ihabafia/permissions-admin
The permissions admin for Spatie laravel-permission package
https://github.com/ihabafia/permissions-admin
admin laravel laravel-permission laravel-permissions livewire permission php role secure spatie-laravel-permission
Last synced: 2 months ago
JSON representation
The permissions admin for Spatie laravel-permission package
- Host: GitHub
- URL: https://github.com/ihabafia/permissions-admin
- Owner: Ihabafia
- License: mit
- Created: 2024-05-07T11:44:04.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-07-08T17:16:31.000Z (6 months ago)
- Last Synced: 2024-10-01T09:22:12.058Z (3 months ago)
- Topics: admin, laravel, laravel-permission, laravel-permissions, livewire, permission, php, role, secure, spatie-laravel-permission
- Language: Blade
- Homepage:
- Size: 57.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# This package for an admin of Spatie Laravel Permission package
[](https://packagist.org/packages/ihabafia/permissions-admin)
[](https://github.com/ihabafia/permissions-admin/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/ihabafia/permissions-admin/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/ihabafia/permissions-admin)
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
This package is a cool livewire GUI for [Spatie Laravel Permission](https://github.com/spatie/laravel-permission) **(not included)**, and it will help you to:
- Create role.
- Create permission.
- Assign role to user.
- Give permission to role.
- Assign role to permission.
- Remove permission from role.
All this via 3 livewire components that will show you the information in a dynamic table which is searchable, sortable and filtered.
## Installation
You can install the package via composer:
```bash
composer require ihabafia/permissions-admin
```
### Additional Steps for installation
1. This package is depend on [Spatie Laravel Permission](https://github.com/spatie/laravel-permission), to install it if you didn't already:
```bash
composer require spatie/laravel-permission
```
2. [Livewire](https://github.com/livewire/livewire) is required, to install it if you didn't already:
```bash
composer require livewire/livewire
```
3. You need to create and empty ```App\Models\Role``` and ```App\Models\Permission``` class and add ```HasPermissionAdmin``` trait as follows:
```php
namespace App\Models;
use IhabAfia\PermissionsAdmin\Traits\HasPermissionAdmin;
use Spatie\Permission\Models\Role as SpatieRole;
class Role extends SpatieRole
{
use HasPermissionAdmin;
}
````
```php
namespace App\Models;
use IhabAfia\PermissionsAdmin\Traits\HasPermissionAdmin;
use Spatie\Permission\Models\Permission as SpatiePermission;
class Permission extends SpatiePermission
{
use HasPermissionAdmin;
}
````
**These classes will not affect your application since these classes extends the original class.**
4. You need to add ```HasPermissionAdmin``` trait in your ```User::class``` like follows:
```php
namespace App\Models;
use Spatie\Permission\Traits\HasRoles;
use IhabAfia\PermissionsAdmin\Traits\HasPermissionAdmin;
class User extends Authenticatable
{
use HasRoles;
use HasPermissionAdmin;
...
}
````
This trait is needed for adding the search functionality to the 3 models.
5. Finally, you need to use this route in ```web.php```
```php
Route::rolesPermissionsAdmin();
```
You might need to publish the config file to change default routes with your own:
```bash
php artisan vendor:publish --tag="permissions-admin-config"
```
Optionally but recommended, you can publish the views using the command bellow, to make sure you get the correct styling of all the component.
```bash
php artisan vendor:publish --tag="permissions-admin-views"
```
## Testing
```bash
Need Help
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ihab Abou Afia](https://github.com/Ihabafia)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.