Skip to content
This repository has been archived by the owner on Mar 20, 2024. It is now read-only.

lloricode/lumen-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7325780 · Jul 19, 2023
Jun 25, 2020
Oct 16, 2022
Oct 15, 2022
Jan 7, 2023
Oct 16, 2022
Oct 16, 2022
Oct 16, 2022
Oct 16, 2022
Oct 16, 2022
Oct 16, 2022
Oct 16, 2022
Dec 15, 2018
Oct 16, 2022
Oct 15, 2022
Mar 25, 2020
Apr 10, 2020
Sep 12, 2020
Dec 27, 2018
Dec 30, 2018
Oct 15, 2022
Apr 16, 2023
Apr 16, 2023
Dec 4, 2021
Oct 16, 2022
Oct 15, 2022
Jul 19, 2023

Repository files navigation

Will stop maintaining this when laravel 10 release. see laravel lumen note.

Screenshot_2023-02-01_11-50-50

Lumen Boilerplate

Run Tests Chat Laravel Forge Site Deployment Status

RESTful API template made from Lumen 9

Previous Lumen Version
8
7
6
5.8
5.7

Installation

1. Download

Clone/Download this repository place on your server. (I highly recommend you use either Laravel Homestead or Laravel Valet, to get the optimal server configuration and no errors through installation.)

2. Environment Files

This boilerplate comes with a .env.example file in the root of the project.

Copy env.example to .env where you prepare your environment.

Note: Make sure you do not rename .env.example, for team purposes.

3. Composer

Lumen boilerplate dependencies are managed through the PHP Composer tool. Install the depencencies by navigating into your project in terminal and typing this command:

composer install

After that run :

php artisan migrate:fresh --seed

Login using OAuth2 by laravel/passport

1. Installation

Install laravel passport by navigating into your project in terminal and run this command:

php artisan passport:install

This will generate Client ID and Client Secret.

2. Access Tokens

Use the Client ID and Client Secret of password grant for OAuth2 - Login (Password grant) endpoint.

API Documentation (Swagger)

You can visit the generated API documentation in http://lumen-boilerplate.test/documentation in your local machine. (working in progress)

Screenshot from 2020-09-13 00-36-59

or here's the published postman here

Testing (Pest)

In your project directory run this command:

composer test

Built With

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

License

This project is licensed under the MIT License.

Todo

  • Replace dingo/api
  • Fix for PHP7.4
  • Log viewer
  • Documentation private route with permission
  • Localization
  • Code Generator
  • Seeder for Test/Production separately
  • Manage seeder for permissions
  • Include Postman collection/Config/Preset
  • Wiki
  • Firewall
  • Social login
  • Back up
  • Data transfer objects (DTO) https://github.com/spatie/data-transfer-object
  • Throttle for lumen
  • Url versioning
  • Finishing swagger
  • spatie/laravel-query-builder

Support Us

Paypal