orchestra/lumen

Lumen Framework for Orchestra Platform

v5.0.3 2020-05-03 17:46 UTC

Requires

• php: >=7.2.5
• laravie/api: ^4.0
• nikic/fast-route: ^1.3
• orchestra/foundation: ^5.0

Requires (Dev)

• mockery/mockery: ^1.3.1
• phpunit/phpunit: ^8.4 || ^9.0

Suggests

• laravel/tinker: Required to use the tinker console command (^2.0).
• nyholm/psr7: Required to use PSR-7 bridging features (^1.2).
• symfony/psr-http-message-bridge: Required to use PSR-7 bridging features (^2.0).
• tymon/jwt-auth: Allows to use JWT-Auth support (^1.0).

MIT

• Mior Muhammad Zaki
• Taylor Otwell

• framework
• laravel
• orchestra-platform
• orchestral
• lumen

README

This repository contains the core code of the Orchestra Lumen. If you want to build an application using Orchestra Platform, visit the main repository.

• Installation
• API Routing
• JWT Authentication

Installation

First, install the Lumenate installer and make sure that the global Composer bin directory is within your system's $PATH:

composer global require "orchestra/lumenate=^1.0"

From within a working Orchestra Platform project, run the following command:

lumenate install

After installing Lumen, you can also opt to add the base Lumen application skeleton under lumen folder, you can do this by running:

lumenate make

You can also choose to add new path to autoload to detect lumen/app using PSR-4 or use a single app directory.

{
    "autoload": {
        "psr-4": {
            "App\\": "app/",
        }
    },
    "autoload-dev": {
        "classmap": [
            "tests/LumenTestCase.php",
            "tests/TestCase.php"
        ]
    },

    "prefer-stable": true,
    "minimum-stability": "dev"
}

It is recommended for you to set "prefer-stable": true and "minimum-stability": "dev" as both laravie/api and tymon/jwt-auth doesn't have a stable release for latest Lumen yet.

API Routing

Dingo API is preinstall with Lumen. To start using it you just need to uncomment the following from lumen/bootstrap.php:

require base_path('lumen/routes/api.php');

JWT Authentication

Install tymon/jwt-auth via the command line:

composer require "tymon/jwt-auth=^1.0"

Next, enable the following service providers from lumen/bootstrap.php:

$app->register(Tymon\JWTAuth\Providers\LumenServiceProvider::class);

// ...

$app->register(App\Lumen\Providers\AuthServiceProvider::class);

Next, we need to create a secret key for JWT:

php lumen/artisan jwt:secret

This would add JWT_SECRET value to your main .env file.

Finally you can extends the default App\User model to support Tymon\JWTAuth\Contracts\JWTSubject:

<?php 

namespace App;

use App\Lumen\User as Eloquent;

class User extends Eloquent
{
    //
}