Starter Kit for Laravel Sanctum

An opinionated starter kit for RESTful API development with Laravel Sanctum.

Requirements

• Laravel ^12
• PHP ^8.2

Features

• Login
• Registration
• Email verification
• Password reset
• Users management
• API Documentation with Scribe
• API versioning

Installation

git clone https://github.com/eliseekn/laravel-sanctum-starter-kit.git project-name
cd project-name && composer install
cp .env.example .env

To do

1. Add front-end url in the .env file

FRONTEND_URL=http://localhost

2. Edit the boot method in AppServiceProvider.php file to ensure that your front-end endpoints are correct

VerifyEmail::createUrlUsing(function ($notifiable) {
    // $url is directly set as the API endpoint for email verification
    // see 'verification.verify' route
    $url = URL::temporarySignedRoute(
        'verification.verify',
        now()->addMinutes(config('auth.verification.expire', 60)), [
            'id' => $notifiable->getKey(),
            'hash' => sha1($notifiable->getEmailForVerification()),
        ]
    );

    return config('app.frontend_url').'/email-verification?url='.urlencode($url);
});

ResetPassword::createUrlUsing(
    fn ($user, string $token) => config('app.frontend_url').'/reset-password?email=' . $user->email . '&token='.$token
);

3. Setup your mail server

Testing

php artisan test

Documentation

Run php artisan serve and open http://127.0.0.1:8000/docs in your web browser.