williams9438 / lumen-boilerplate

API template made from Lumen 5.7.*, authenticated with Oath implemented by laravel/passport

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status

A template made from Lumen 5.7.*, authenticated with laravel/passport

Installing

  • after cloning/downloding this repo, first open to terminal then change directory to a project directory.
  • sample, in linux, cd lumen-boilerplate.
  • run composer install to install project dependencies.
  • copy .env.example to .env. (dont just rename it), for team reference purpose.
  • prepare you environment in .env
  • lumen has no php artisan key:generate, so you can google it to add value first.
  • run composer fresh, this will migrate and seed fake data to your database, and install laravel passport. see composer.json scripts index.
  • if you not familiar with laravel/passport, you must see this first.
  • how to login? see laravel/passport

Available Endpoints

  • to generate documentation run php artisan apidoc:generate, then visit http://lumen-boilerplate.test/docs on browser.

Running the tests

  • you can view integration here
  • go to project directory.
  • run vendor/bin/phpunit, if you running this via homestead, you can run this through ssh via phpunit in current project directory.
  • run composer coverage to see code coverage via html.
  • run composer coverage-txt to see code coverage via terminal.

Built With

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

API template made from Lumen 5.7.*, authenticated with Oath implemented by laravel/passport

License:MIT License


Languages

Language:PHP 100.0%