graham-campbell / logviewer
LogViewer Provides A LogViewer Admin Module For Laravel 5
Requires
- php: >=5.5.0
- graham-campbell/core: ~2.0
- illuminate/filesystem: 5.0.*
- illuminate/pagination: 5.0.*
- illuminate/routing: 5.0.*
- illuminate/session: 5.0.*
- illuminate/support: 5.0.*
- illuminate/view: 5.0.*
- lightgear/asset: ~2.0
Requires (Dev)
Suggests
- graham-campbell/navigation: Easily add a navigation bar.
This package is not auto-updated.
Last update: 2022-02-01 12:45:33 UTC
README
Laravel LogViewer was created by, and is maintained by Graham Campbell, and provides a LogViewer admin module for Laravel 5. Feel free to check out the releases, license, and contribution guidelines.
Installation
PHP 5.5+ or HHVM 3.6+, and Composer are required.
To get the latest version of Laravel LogViewer, simply add the following line to the require block of your composer.json
file:
"graham-campbell/logviewer": "~1.0"
You'll then need to run composer install
or composer update
to download it and have the autoloader updated.
Once Laravel LogViewer is installed, you need to register the service provider. Open up config/app.php
and add the following to the providers
key.
'GrahamCampbell\LogViewer\LogViewerServiceProvider'
Configuration
Laravel LogViewer supports optional configuration.
To get started, you'll need to publish all vendor assets:
$ php artisan vendor:publish
This will create a config/logviewer.php
file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.
There are two config options:
Middleware
This option ('middleware'
) defines the middleware to be put in front of the endpoints provided by this package. A common use will be for your own authentication middleware. The default value for this setting is []
.
Per Page
This option ('per_page'
) defines defines how many log entries are displayed per page. The default value for this setting is 20
.
Layout
This option ('layout'
) defines the layout to extend when building views. The default value for this setting is 'layouts.default'
.
Usage
Laravel LogViewer is designed to work with Bootstrap CMS. In order for it to work in any Laravel application, you must ensure that you know how to use my Laravel Core package as configuration and knowledge of the app:install
and app:update
commands is required.
Laravel LogViewer will register four routes. The only one of interest to you is 'logviewer'
(logviewer.index
) as it will be the main entry point for the use of this package. You can checkout the other three routes in the source if you must.
License
Laravel LogViewer is licensed under The MIT License (MIT).