mostafasoufi/lumen-starter

Lumen starter is a Laravel Lumen which most common packages, tools, and class that you need to fire an API for your project.

Lumen Starter

Lumen starter is a Laravel Lumen which most common packages, tools, and class that you need to fire an API for your project.

Features

• Simple classes for starting with Lumen
• User authentication base on JWT
• User Account and User Profile controllers
• Two Mailable class
• A Resource class to get profile response
• Support a Helper class
• Test cases class for all endpoints
• English language files
• Packages
  • Lumen Generator
  • Guzzle, PHP HTTP client
  • Illuminate Mail component
  • JWT Auth

Requirements

• PHP >= 7.1.3
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension
• Composer dependency manager

Installation

1. Clone the repo

To install the Lumen Starter you should take a clone from the repository in your local with below command:

git clone https://github.com/mostafasoufi/lumen-starter.git

Then go to project with cd

cd lumen-starter

2. Install packages & dependencies the repo

Then try to install all packages with the composer:

composer install

3. Configuration

All of the configuration options for the Lumen framework are stored in the .env file. take a copy from .env.example to .env.

cp .env.example .env

You should also configure your local environment in this file.

4. Generate secret key

This will update your .env file with something like JWT_SECRET=foobar

php artisan jwt:secret

5. Serving Your Application

To serve your project locally, you can use the built-in PHP development server:

php -S localhost:8000 -t public

Unit Test

vendor\bin\phpunit