durrbar / user-module
Laravel User module for authentication, authorization with Fortify, Sanctum, Socialite and laravel-permission by Spatie
Installs: 46
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:laravel-module
pkg:composer/durrbar/user-module
Requires
- php: ^8.2
 - intervention/image-laravel: ^1.5
 - laravel/fortify: ^1.20
 - laravel/sanctum: ^4.0
 - laravel/socialite: ^5.11
 - spatie/laravel-permission: ^6.4
 
README
The User Module is a powerful and flexible Laravel package designed to streamline user management. It provides essential functionality for managing users, roles, and permissions in Laravel applications.
Features
- User authentication (login, registration, password reset)
 - Role-based access control (RBAC)
 - Permission-based authorization
 - API-ready user management endpoints
 - Easily extendable and customizable
 
Installation
Requirements
- PHP >= 8.2
 - Laravel >= 11.0
 
Step 1: Install via Composer
composer require durrbar/user-module
Step 2: Publish Config and Migrations
Publish the configuration and migration files using the following command:
php artisan durrbar:user-install
Step 3: Run Migrations
Run the database migrations to set up the necessary tables:
php artisan migrate
Step 4: Configure the Package
Edit the published configuration file located at config/user-module.php to customize settings such as default roles and permissions.
Usage
User Authentication
The package includes ready-to-use authentication routes for login, registration, and password reset. You can use the following endpoints:
- POST /login - Authenticate users
 - POST /register - Register new users
 - POST /password-reset - Request a password reset
 
API Documentation
The package includes the following API endpoints:
| Endpoint | Method | Description | 
|---|---|---|
/api/users | 
GET | List all users | 
/api/users/{id} | 
GET | Retrieve a specific user | 
/api/users | 
POST | Create a new user | 
/api/users/{id} | 
PUT | Update a user's information | 
/api/users/{id} | 
DELETE | Delete a user | 
Testing
To run tests, use the following command:
php artisan test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Contributions are welcome! Please follow these steps:
- Fork the repository.
 - Create a new feature branch.
 - Commit your changes.
 - Submit a pull request.
 
Please see CONTRIBUTING for details.
License
This package is open-sourced software licensed under the MIT license.
Support
For issues or feature requests, please open an issue on the GitHub repository.
Credits
- Author: Durrbar
 - Packagist: durrbar/user-module