kriosmane / menu-api

Menu API

Simple Laravel REST API project with Test-Driven Development

Installation

1. Run the command below to install:

composer install

2. Copy .env file

cp .env.example .env

3. In file .env set database

...
DB_DATABASE=db_name
DB_USERNAME=db_username
DB_PASSWORD=db_password
...

4. Migrate database

php artisan migrate

5. Set encryption key

php artisan key:generate

6. Install passport

php artisan passport:install

7. Generate API documentation

php artisan l5-swagger:generate

Access API documentation

1. Run the command below to start the server:

php artisan serve --host=127.0.0.1 --port=8000

2. Visit this page http://127.0.0.1:8000/api/documentation to access the API Documentation

Run Tests

Run the commands below:

./vendor/bin/phpunit tests/Feature/AuthTest.php

./vendor/bin/phpunit tests/Feature/ItemTest.php

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• kriosmane

License

The MIT License (MIT). Please see License File for more information.