talentql api

Laravel API for TODO app

A REST API which allows users create todos

Description

This project was built with Laravel and MySQL.

Project Features

Authentication:

• JWT Auth

Project:

• Create/Edit projects
• View/Delete projects

Todo:

• Manage todos
• Attach todo to a project

Integration testing :

• PHPUnit (https://phpunit.de)
• Faker (https://github.com/fzaninotto/Faker)

Running the API

To run the API, you must have:

• PHP (https://www.php.net/downloads)
• MySQL (https://dev.mysql.com/downloads/installer)

Create an .env file using the command. You can use this config or change it for your purposes.

$ cp .env.example .env

Environment

Configure environment variables in .env for dev environment based on your MYSQL database configuration

DB_CONNECTION=
DB_HOST=
DB_PORT=
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

API documentation

API End points and documentation can be found at: Postman Documentation.

Installation

Install the dependencies and start the server

$ composer install
$ php artisan key:generate
$ php artisan migrate
$ php artisan serve

You should be able to visit your app at http://localhost:8000

Testing

To run integration tests:

$ composer test