andrey-helldar/pretty-routes

v2.3.1 2021-07-06 21:26 UTC

README

Visualise your routes in pretty format.

Pretty RoutesLight Theme

Pretty Routes Dark Theme

StyleCI Status Github Workflow Status Coverage Status Scrutinizer Code Quality For Laravel

Stable Version Unstable Version Total Downloads License

Installation

Laravel Framework

composer require andrey-helldar/pretty-routes --dev

If your using autodiscovery in Laravel, it should just work.

Otherwise - add to your config/app.php providers array to where all your package providers are (before your app's providers):

PrettyRoutes\ServiceProvider::class,

Lumen Framework

composer require andrey-helldar/pretty-routes --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');
}

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 garygreen/pretty-routes

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

Compatibility table

PHP \ Laravel, Lumen 5.0-5.3 5.4 5.5 5.6 5.7 5.8 6.x 7.x 8.x
7.2 Supported, not tested
7.3 Supported, not tested
7.4 Supported, not tested
8.0 Not supported, not tested

License

This package is licensed under the MIT License.

For Enterprise

Available as part of the Tidelift Subscription.

The maintainers of andrey-helldar/pretty-routes and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.