Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fruitcake/laravel-telescope-toolbar
A toolbar for Laravel Telescope, based on the Symfony Web Profiler.
https://github.com/fruitcake/laravel-telescope-toolbar
hacktoberfest
Last synced: about 2 months ago
JSON representation
A toolbar for Laravel Telescope, based on the Symfony Web Profiler.
- Host: GitHub
- URL: https://github.com/fruitcake/laravel-telescope-toolbar
- Owner: fruitcake
- License: mit
- Created: 2019-08-09T08:25:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T06:04:32.000Z (6 months ago)
- Last Synced: 2024-07-18T23:37:25.936Z (2 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 247 KB
- Stars: 769
- Watchers: 8
- Forks: 35
- Open Issues: 17
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
## Laravel Telescope Toolbar
[](http://choosealicense.com/licenses/mit/)
[](https://packagist.org/packages/fruitcake/laravel-telescope-toolbar)
[](https://packagist.org/packages/fruitcake/laravel-telescope-toolbar)
[](https://fruitcake.nl/)
### Extends Laravel Telescope to show a powerful Toolbar
See https://github.com/laravel/telescope
#### Install
First install Telescope and check it works (see https://laravel.com/docs/master/telescope)
```bash
composer require laravel/telescope
php artisan telescope:install
# Telescope 5.0 no longer automatically loads migrations from its own migrations directory. Instead, you should run the following command to publish Telescope's migrations to your application:
php artisan vendor:publish --tag=telescope-migrations
php artisan migrate
```
Then just install the package with Composer and it will register automatically:
```bash
composer require fruitcake/laravel-telescope-toolbar --dev
```
The Toolbar will show by default when Telescope is enabled and APP_DEBUG is true.
It can also enabled or disabled using the `TELESCOPE_TOOLBAR_ENABLED` environment variable.
> Note: The Toolbar is intended for Development environments, not for production.
## Publishing the config
Run this command to publish the config for this package:
```php
php artisan vendor:publish --provider="Fruitcake\\TelescopeToolbar\\ToolbarServiceProvider"
```
#### Current Features
- Inject Toolbar for quick info
- Show redirects and Ajax Requests
- Link to related Telescope Entry page
- Show up to 5 entries for collectors, link to details
- Supported Collectors:
* Request info / timing
* User auth
* Database queries
* Laravel/php version
* Cache hit/miss/set
* Logger entries
* Exceptions
* Mails
* Notifications
* Jobs
* Dumps (when watching the Dump screen, or using `debug(...$args)`)
* Number of entries for: Commands/Models/Events
#### Screenshots
Ajax/ Redirects stack:
Preview for Exceptions/Mail/Notifications/Log entries with link to details:
Counter for Queries (and Cache etc):
Catch `debug()`/`Toolbar::dump()` calls and show them directly in the Toolbar instead of the page:
## Running the Test Suite
- Make sure ChromeDriver is up to date: `vendor/bin/dusk-updater detect --auto-update`
- Create the Sqlite database: `vendor/orchestra/testbench-dusk/create-sqlite-db`
- Run the tests: `composer test`
## License and attribution
Laravel Telescope Toolbar is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
### Based on Symfony Web Profiler and Laravel Telescope
The styling, javascript, some icons and html of the Toolbar and (part of) its Collectors are based on the Symfony Web Profiler.
JS/CSS is mostly copied and converted to Blade syntax. Collectors are modified to show Laravel data.
See https://github.com/symfony/web-profiler-bundle - Copyright (c) 2004-2019 Fabien Potencier
Data from collectors is provided by Laravel Telescope. Some styling/icons/logic are alse re-used.
See https://github.com/laravel/telescope - Copyright (c) Taylor Otwell