README

**As of 27 July 2020, I forked this to take over and use this separately from the main repo as Dave is no longer supporting it. Also tired of getting the notifications "package no longer supported" when I do composer install/update/dumpautoload etc.

— Thato

As of 18 April 2020, Laravel Route Browser is not being maintained.

It started out as an experimental project to learn about Laravel's routing system and create an improved UI over artisan route:list, but the effort required to maintain it (especially when the Laravel routing internals change) outweighs the benefit.

There are a few alternatives listed below, but if you want to create your own fork, to fix bugs or add new features, please see the instructions below. The MIT license requires you to keep the copyright notice and license information, but otherwise you can do what you like with the code and documentation.

— Dave

Laravel Route Browser

A web-based route list GUI for Laravel.

(Similar to Pretty Routes, Laravel Routes Explorer and Laravel Route Summary, but with more details and better search.)

Compatibility Chart
Installation
Contributing
No Technical Support
Changelog
License

Compatibility Chart

Installation

composer require --dev thatobabusi/laravel-route-browser

Optionally publish and edit the config file (config/route-browser.php):

php artisan vendor:publish --tag=route-browser-config

Then visit /routes (or the path set in your config file).

For security, by default, Route Browser is only active if APP_ENV=local and APP_DEBUG=true, or you set ROUTE_BROWSER_ENABLED=true, in .env. You should not enable it in production or any publically accessible environments.

Contributing

Documentation: If you think the documentation can be improved in any way, please do edit this file and make a pull request.

Bug fixes: Please fix it and open a pull request. (See below for more detailed instructions.) Bonus points if you add a unit test to make sure it doesn't happen again!

New features: Please build it and open a pull request. If you want to discuss it before doing too much work, make a proof-of-concept (either code or documentation) and open a Draft PR to discuss the details.

Creating a pull request

The easiest way to work on Laravel Route Browser is to tell Composer to install it from source (Git) using the --prefer-source flag:

rm -rf vendor/thatobabusi/laravel-route-browser
composer install --prefer-source

Then checkout the master branch and create your own local branch to work on:

cd vendor/thatobabusi/laravel-route-browser
git checkout -t origin/master
git checkout -b YOUR_BRANCH

Now make your changes, including unit tests and documentation (if appropriate). Run the unit tests to make sure everything is still working:

scripts/test.sh

Then commit the changes. Fork the repository on GitHub if you haven't already, and push your changes to it:

git remote add YOUR_USERNAME git@github.com:YOUR_USERNAME/laravel-route-browser.git
git push -u YOUR_USERNAME YOUR_BRANCH

Finally, browse to the repository on GitHub and create a pull request.

(Alternatively, there is a test app that you can use.)

Using your fork in a project

To use your own fork in a project, update the composer.json in your main project as follows:

{
    // ADD THIS:
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/YOUR_USERNAME/laravel-route-browser.git"
        }
    ],
    "require": {
        // UPDATE THIS:
        "thatobabusi/laravel-route-browser": "dev-YOUR_BRANCH"
    }
}

Replace YOUR_USERNAME with your GitHub username and YOUR_BRANCH with the branch name (e.g. develop). This tells Composer to use your repository instead of the default one.

Unit tests

To run the unit tests:

scripts/test.sh

To check code coverage:

scripts/test-coverage.sh

Then open test-coverage/index.html to view the results. Be aware of the edge cases in PHPUnit that can make it not-quite-accurate.

New version of Laravel

There is no maximum version specified in composer.json, so there is no need for a new version of Laravel Route Browser to be released every 6 months. However, this file will need to be updated to run tests against the new version:

.travis.yml
- matrix (Laravel versions)
- php (PHP versions)
- exclude (Unsupported combinations)

If changes are required, also update:

README.md
- Compatibility Chart
- Changelog

If backwards-incompatible changes cause the minimum supported versions of Laravel or PHP to change, update:

composer.json
- php/*
- illuminate/*

Releasing a new version

This section is for maintainers only.

Ensure the unit tests are updated ~~and have 100% coverage~~ (eventually)
Update the test app, if appropriate, and test it manually
Ensure the README is up to date, including:
- Document any new features
- Compatibility Chart
- Changelog
Merge the changes into the master branch (if necessary)
Push the code changes to GitHub (git push)
Make sure all tests are passing
Tag the release (git tag 1.2.3)
Push the tag (git push --tag)

No Technical Support

Sorry, I don't offer any technical support, and GitHub Issues are disabled. That means I won't figure out why it's not working for you, I won't fix bugs for you, and I won't write new features on request - this is free software after all.

But the beauty of open source is you can do whatever you want with it! You can fork it, fix it, improve it and extend it. If you don't want to maintain your own fork, and you think other people would benefit from your changes, you can submit a pull request to have your changes included in the next release.

If you get really stuck, I suggest you:

Read and re-read both this file and the Laravel documentation to see if you missed something.
Dive into the source code and spend some time figuring out how it's meant to work and what's actually happening.
Try to reproduce the problem on a brand new Laravel project, in case it's an incompatibility with another package or your other code.
Ask your colleagues to help you debug it, if you work in a team.
Pay someone more experienced to help you (or if you work for a company, ask your boss to pay them).
Try posting on Stack Overflow, Laravel.io Forum or Laracasts Forum (but I can't promise anyone will answer - they don't get paid either).
Use a different package instead.
Write your own.

Changelog

Laravel Route Browser uses Semantic Versioning.

v1.1.1 (Wed 26 Feb 2020)

Fix filtering in Laravel 7

v1.1.0 (Fri 17 Jan 2020)

Fix filtering by URL when not running in a subdirectory – Thanks to Nguyễn Trần Chung
Add excludes array to config file – Also thanks to Nguyễn Trần Chung

v1.0.1 (Thu 2 Jan 2020)

Fix displaying middlewares that are closures
Fix displaying middlewares added in the controller rather than the route

v1.0.0 (Tue 31 Dec 2019)

Initial release

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

thatobabusi / laravel-route-browser

Maintainers

Details