README.md

Laravel Todo API

A simple RESTful API for managing to-do items. Equipped with Sanctum token based authentication and laravel-permission permission based authorization.

This project aims to demonstrate a real-world Laravel RESTful API that adheres to the community's best practices and coding standards.

Installation

To install the dependencies, navigate to the project's root directory and run:

composer install

Copy the contents of .env.example to a .env file, or simply run this command:

# Linux
cp .env.example .env
# Windows
copy .env.example .env

Configure the environment variables on the .env file then generate the application key by running:

php artisan key:generate

To the run the migrations, execute the migrate command:

php artisan migrate

Run the seeder to create users, roles, and permissions using this command:

php artisan db:seed

Postman Collection

Published documentation of the Postman collection can be found here. You can run the collection by clicking the ► Run in Postman button on the documentation page. The Development environment must be set as the active environment.

Environment Variable	Description
server	Must be manually set with the application's URL
token	Automatically set after a successful login