Backend for https://github.com/guillaumebriday/todolist-frontend app, built for a serie of articles on my blog.

The purpose of this repository is to provide API with Laravel 5.6 and connecting JavaScript front-end frameworks like Vue.js or other clients to them.

Beside Laravel, this project uses other tools like :

• PHP-CS-Fixer
• Travis CI
• tymon/jwt-auth
• spatie/laravel-cors
• spatie/laravel-backup
• Redis

Development environment requirements :

• Docker
• Docker Compose

Setting up your development environment on your local machine :

$ git clone https://github.com/guillaumebriday/todolist-backend.git
$ cd todolist-backend
$ cp .env.example .env
$ docker-compose run --rm --no-deps todolist-server composer install
$ docker-compose run --rm --no-deps todolist-server php artisan key:generate
$ docker-compose run --rm --no-deps todolist-server php artisan jwt:secret
$ docker-compose up -d

You need to run the migrations :

$ docker-compose run --rm todolist-server php artisan migrate

Running tests :

$ docker-compose run --rm todolist-server ./vendor/bin/phpunit

Running php-cs-fixer :

$ docker-compose run --rm --no-deps todolist-server ./vendor/bin/php-cs-fixer fix --config=.php_cs --verbose --dry-run --diff

Generating backup :

$ docker-compose run --rm todolist-server php artisan backup:run --only-db

Discover package

$ docker-compose run --rm --no-deps todolist-server php artisan package:discover

Generating fake data :

$ docker-compose run --rm todolist-server php artisan db:seed --class=DevDatabaseSeeder

Clients can access to the REST API. API requests require authentication via JWT. You can create a new one with you credentials.

$ curl -X POST localhost:8000/api/v1/auth/login -d "email=your_email&password=your_password"

Then, you can use this token either as url parameter or in Authorization header :

# Url parameter
curl -X POST http://localhost:8000/api/v1/auth/me?token=your_jwt_token_here

# Authorization Header
curl -X POST --header "Authorization: Bearer your_jwt_token_here" http://localhost:8000/api/v1/auth/me

API are prefixed by api and the API version number like so v1.

Do not forget to set the X-Requested-With header to XMLHttpRequest. Otherwise, Laravel won't recognize the call as an AJAX request.

To list all the available routes for API :

$ docker-compose run --rm --no-deps todolist-server php artisan route:list

More details are available on my blog post : https://guillaumebriday.fr/laravel-vuejs-faire-une-todo-list-partie-1-presentation-et-objectifs (French).

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

This project is released under the MIT license.