xaamin/sanctum

Laravel/Lumen Sanctum provides a featherweight authentication system for SPAs and simple APIs.

v1.0.2 2024-09-26 23:53 UTC

This package is auto-updated.

Last update: 2024-10-27 00:08:36 UTC


README

Logo Laravel Sanctum

Build Status Total Downloads Latest Stable Version License

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.