Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s-patompong/laravel-routes-html
View your Laravel routes on the browser.
https://github.com/s-patompong/laravel-routes-html
alpinejs laravel laravel-route route-list route-list-browser route-list-html
Last synced: about 1 month ago
JSON representation
View your Laravel routes on the browser.
- Host: GitHub
- URL: https://github.com/s-patompong/laravel-routes-html
- Owner: s-patompong
- License: mit
- Created: 2021-11-24T12:08:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-02T03:34:19.000Z (about 3 years ago)
- Last Synced: 2023-11-20T16:03:39.444Z (about 1 year ago)
- Topics: alpinejs, laravel, laravel-route, route-list, route-list-browser, route-list-html
- Language: Blade
- Homepage:
- Size: 85.9 KB
- Stars: 26
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# View your Laravel routes on the browser 🏖
[](https://packagist.org/packages/s-patompong/laravel-routes-html)
[](https://github.com/s-patompong/laravel-routes-html/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/s-patompong/laravel-routes-html/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/s-patompong/laravel-routes-html)
This package adds a route to your Laravel application. Once you've installed this package, enter `/route-list` path in the browser to see your route list.
https://user-images.githubusercontent.com/3887531/144168468-b5774116-6068-4eed-b57a-8c572554de8e.mov
## Features
- See all routes in your Laravel application in a nicely formatted table with responsive layout.
- Sort routes by domain, method, uri, name, action, and middleware.
- Quickly filter to see only the routes that you want. 🎉
- Click on the GET|HEAD route to open it on a new tab. You need to specify the parameters if the route requires them. 😎
## Installation
You can install the package via composer:
```bash
composer require s-patompong/laravel-routes-html
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="routes-html-config"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="routes-html-views"
```
This is the contents of the published config file:
```php
return [
/**
* Either you want to enable or disable the route
* It should be enabled only in the local environment
* By default, it'll be enabled if the app.debug is true
*/
'enabled' => (bool) env('ROUTES_HTML_ENABLED', config('app.debug')),
/**
* The route URI
*/
'uri' => '/route-list',
/**
* The route name
*/
'route_name' => 'routes',
/**
* The list of route to ignore
*/
'ignore_routes' => [
'_ignition/*',
'sanctum/*',
'livewire/*',
],
/**
* The list of middleware that you want
* the request to run through before hitting
* the /route-list route
*/
'middlewares' => [
// Example: uncomment the first line below
// to allow only the authenticated user
// to use the /route-list route
// \App\Http\Middleware\Authenticate::class
],
];
```
## Usage
Open your Laravel application on the browser and go to `/route-list` URL (or the URL that you put inside the `routes-html.uri`).
### Route Middlewares
To add middlewares to the request pipeline before it hits the `/route-list` route.
Add the middleware classname to the `middlewares` key in the config file like so:
```php
'middlewares' => [
\App\Http\Middleware\Authenticate::class
]
```
This will make sure that only the authenticated user can access the `/route-list` route.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Patompong Savaengsuk](https://github.com/s-patompong)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.