This is a solution for the Buzzvel Task API, which is a simple API that allows you to create, update, delete and list tasks.

João is tired of forgetting his tasks that he need to do daily. Your goal is to create a tool that helps João to solve his problem in a simple way.

The solution was developed using Laravel 10, PHP 8.2, MySQL 8.0.23, Docker and Docker Compose. The solution is a REST API that allows you to create, update, delete and list tasks. A user can only update and delete his own tasks. The API is protected by a Sanctum token. The API is documented using Postman.

User Login

• Email: [email protected]
• Password: P@ssw0rd

• Clone the repository

git clone https://github.com/hendurhance/buzzvel-task.git

• Enter the project folder

cd buzzvel-task

• Copy the .env.example file to .env

cp .env.example .env

• Run the containers

docker-compose up -d

• Install the dependencies

docker exec -it buzzvel-app-1 bash

• Make sure you are in the /var/www/html folder

cd /var/www/html

• Install the dependencies

composer install

• Generate Application Key

php artisan key:generate

• Storage Link & Grant Permission

php artisan storage:link

chmod -R 755 storage

• Run the migrations and seeds

php artisan migrate --seed

• Run the tests

php artisan test

• Run PHP Insights

php artisan insights

• [✅] Unique identifier of the task (ID)
• [✅] Task Title
• [✅] Task Description
• [✅] Attachment File(s)
• [✅] Mark as Completed (indicates if the task is completed or not)
• [✅] Dates ( date that the task was created, completed, updated and deleted)
• [✅] User (user that created the task)

• [✅] The API must return the correct HTTP status code and a message explaining the error.
• [✅] The API must return the validation errors in a readable format.
• [✅] The API must return errors when a resource is not found/do not exist.
• [✅] The project has 21 tests.

• PHP 8.2
• Laravel 10
• Repository Design Pattern
• Dependency Injection
• 20 Tests
• 85% on PHP Insights
• Swagger Doc

The API is documented using Postman. You can import the Buzzvel Task API.postman_collection.json file into Postman to see the documentation.