xaamin / sanctum
Laravel/Lumen Sanctum provides a featherweight authentication system for SPAs and simple APIs.
Requires
- php: ^8.0.2
- ext-json: *
- illuminate/console: ^9.21|^10.0|^11.0
- illuminate/contracts: ^9.21|^10.0|^11.0
- illuminate/database: ^9.21|^10.0|^11.0
- illuminate/support: ^9.21|^10.0|^11.0
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: ^7.0|^8.0|^9.0
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^9.3
- squizlabs/php_codesniffer: ^3.7
README
Introduction
Lumen Sanctum provides a featherweight authentication system for SPAs and simple APIs.
Installation
This package requires requires php >= 8.0 and lumen >= 9
Step 1 - Install the package on your project
composer require xaamin/sanctum
Step 2 - Add the service provider in bootstrap/app.php
$app->register(
Laravel\Sanctum\SanctumServiceProvider::class
);
Step 3 - Use sanctum
as your driver for api
guard in your config/auth.php
file, copy the auth config file sample from here.
'guards' => [
'api' => [
'driver' => 'sanctum',
'provider' => 'users',
'hash' => false,
],
],
Official Documentation
Documentation for Sanctum can be found on the Laravel website.
Contributing
Thank you for considering contributing to Sanctum! The contribution guide can be found in the Laravel documentation.
Code of Conduct
In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
License
Lumen Sanctum is open-sourced software licensed under the MIT license.