Skip to content

This is a Todo API built using the Laravel PHP framework

Notifications You must be signed in to change notification settings

albertoodev/todo-app

Repository files navigation

Todo Api using laravel


This is a Todo API built using the Laravel PHP framework. I made this application after learning Laravel basics to create and manage todo lists using RESTful API endpoints.

Build Status Total Downloads Latest Stable Version License


Features

  • User authentication and authorization
  • Todo management (add, edit, delete,update)
  • Change the Todo state

Requirements

  • PHP >= 7.4
  • MySQL or any other compatible database server
  • Laravel >= 8.x

Installation

1- Clone this repository using Git or download the ZIP file. 2- Configure the database settings in the '.env' file. 3- Install the required dependencies using :

composer install

4- Run the migrations using :

php artisan migrate

5- Start the server using :

php artisan serve

Usage

Authentication

Users will be required to sign up or log in to access the API endpoints. Once authenticated, users will be able to access the various features of the application.

Tasks Management

Users can create new todos by providing a title, description, and due date. Existing todos can also be edited or deleted as needed.

User Management

Users can create new accounts by providing their personal details such as name, email, and password. Existing users can also be edited or deleted as needed.

API Endpoints

The following API endpoints are available:

Auth & User managment

  • POST /api/login - log in the user
  • POST /api/register - create a new user
  • POST /api/logout - logout the user
  • Get /api/getUsers -retrieve a list of users

Tasks

  • GET /api/getAll - get pending tasks
  • GET /api/getDoneTasks - get done tasks
  • POST /api/add - create a new task
  • DELETE /api/todos/{id} - delete a specific task
  • POST /api//update/{id} - update a specific task
  • POST /setStat/{id} - change the state of a specific task from pending to done or from done to pending

Contributing

Contributions are welcome! Please submit any bug reports, feature requests, or pull requests through the Github repository.

About

This is a Todo API built using the Laravel PHP framework

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages