search

TheDragonCode / pretty-routes

Pretty routes for Laravel Framework
MIT License
96 stars 7 forks source link

readme

Pretty Routes for Laravel

Visualise your routes in pretty format.

Pretty RoutesLight Theme

Pretty Routes Dark Theme

Stable Version Unstable Version Total Downloads Github Workflow Status License

Installation

Laravel Framework

To get the latest version of Pretty Routes, simply require the project using Composer:

composer require dragon-code/pretty-routes --dev

Lumen Framework

We do not provide support for the Lumen Framework because we consider it to be an insufficiently functional product, as a result of which various errors may occur on more recent versions of Lumen.

In addition, Taylor Otwell also announced the end of support for Lumen.

image

To get the latest version of Pretty Routes, simply require the project using Composer:

composer require dragon-code/pretty-routes dragon-code/laravel-routes-core:^4.1 --dev

In your bootstrap/app.php file add a line above $app->register(App\Providers\RouteServiceProvider::class):

if (env('APP_ENV') !== 'production') {
    $app->register(\PrettyRoutes\ServiceProvider::class);
    $app->configure('pretty-routes');
}

Next, copy config file to config/pretty-routes.php and change options to:

return [
    // ...

    'web_middleware' => null,
    'api_middleware' => null,

    // ...
];

Both frameworks

By default, the package exposes a /routes url. If you wish to configure this, publish the config.

php artisan vendor:publish --provider="PrettyRoutes\ServiceProvider"

If accessing /routes isn't working, ensure that you've included the provider within the same area as all your package providers (before all your app's providers) to ensure it takes priority.

By default, pretty routes only enables itself when APP_DEBUG env is true. You can configure this on the published config as above, or add any custom middlewares.

Upgrade from another packages

Upgrade from andrey-helldar/pretty-routes

  1. In your composer.json file, replace "andrey-helldar/pretty-routes": "^2.0" with "dragon-code/pretty-routes": "^3.0".
  2. Run the command composer update.
  3. Profit!

Upgrade from garygreen/pretty-routes

  1. In your composer.json file, replace "garygreen/pretty-routes": "^1.0" with "dragon-code/pretty-routes": "^3.0".
  2. Run the command composer update.
  3. Profit!

Using

Open the /routes uri. For example, http://localhost:8000/routes

License

This package is licensed under the MIT License.