Lumen PHP Framework

Laravel Lumen is a stunningly fast PHP micro-framework for building web applications with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Lumen attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as routing, database abstraction, queueing, and caching.

Official Documentation

Documentation for the framework can be found on the Lumen website.

About Recursive TODO

This projects was built with Laravel Lumen 5.7 and provides a recursive todo list. It's very simple, just 3 tables:

• Todo item: The task itself
• Status: Configurable status
• Status Log: Registers each status change

Each item may have a parent or not. The first level doesn't have parent and by geting a specific item by it's id you can get all status change history and it's children.

Requeriments

As Lumen 5.7 requires php 7.1.3 or higher, this project requires it too

• PHP >= 7.1.3
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension

Clone and Install

You can get the repository from https://github.com/xStarman/recursive-todo by clicking in "Clone or Download" and Download ZIP file or run $ git clone https://github.com/xStarman/devsquad-laravel.git in a directory you prefer.

With all cloned files you will need to run composer to install dependencies: $ composer /path/to/cloned/dir install

Migrate columns (don't forget to change default .ENV db data to your data): $ php artisan migrate

Start Server

You can use xampp or something like, but maybe you would like to use PHP's built in server by running $ php -S localhost:8000 -t public into the installation directory

Endpoints

Todo Items aka Task

GET -> /todo/item[/id_item]

Get a list of items or some specific item -> when geting a specific item, history and children will come together

POST -> /todo/item

Creates a new Todo Item

Body

{
	"status_id"	:1,
	"parent_id" : 1,
	"todo_name"	: "Nice Task",
	"todo_description" : "Task description",
	"expected_end_date": "2019-01-23",
}

PUT -> /todo/item/[id_item]

Update a task -> If the status change status_change_reason must be provided. Also creates a new Status log record

Body

{
	"status_id"	:1,
	"parent_id" : 1,
	"todo_name"	: "Nice Task",
	"todo_description" : "Task description",
	"expected_end_date": "2019-01-23",
	"status_change_reason": "New status reason"
}

DELETE -> /todo/item/[id_item]

Delete a task -> changes todoitem active column to false

Status

GET -> /todo/status[/id_item]

Get a list of status or some specific status

POST -> /todo/status

Creates a status -> Lower priority comes first on tasks list

Body

{
	"status_name" : "Done",
	"status_description": "Task was done",
	"color" : "#000",
	"priority": 1
}

PUT -> /todo/status/[id_item]

Update a status

Body

{
	"status_name" : "Done",
	"status_description": "Task was done",
	"color" : "#000",
	"priority": 1
}

DELETE -> /todo/status/[id_item]

Delete status

License

The Lumen framework is open-sourced software licensed under the MIT license.