Overview
The Starter Kit for Laravel Sanctum is an opinionated Laravel starter kit specifically designed for RESTful API development with Sanctum. It provides a set of features and guidelines to quickly set up a Laravel project for API development.
Features
- Login: Allows users to log in to the application.
- Registration: Provides a registration functionality for new users to create an account.
- Email Verification: Includes email verification to ensure valid user accounts.
- Password Reset: Allows users to reset their passwords if forgotten.
- Users Management: Provides functionality for managing user accounts.
Installation
To install the Starter Kit for Laravel Sanctum, follow these steps:
- Add the front-end URL to the
.envfile. - Edit the
bootmethod inAuthServiceProvider.phpfile to ensure that your front-end endpoints are correct. - Set up your mail server.
- Run PHPUnit tests for testing.
- Import the
Laravel Sanctum Starter Kit.postman_collection.jsonfile to Postman for API testing. - Refer to the documentation for further details.
- Run
php artisan servecommand and openhttp://127.0.0.1:8000/docsin your browser to access the API documentation.
Summary
The Starter Kit for Laravel Sanctum is a convenient starting point for developers who want to build RESTful APIs using Laravel and Sanctum. It provides essential features such as authentication, registration, email verification, password reset, and users management. The installation process includes steps to configure the application and set up the required dependencies.