This package serves as a basis for quickly creating a back-office. It includes profile creation and his management, user management, roles, permissions and log viewing.
It also makes it easy to add other packages to extend the features.
For AdminLTE 2 and Bootstrap 3 please use version < 7.0 of this package.
- Configurable backend theme AdminLTE 3
- Css framework Bootstrap 4
- Icons by Font Awesome 5
- Role-based permissions provided by santigarcor/laratrust
- Forms & Html helpers by laravelcollective/html
- Menu dynamically builded by lavary/laravel-menu
- Menu items activated by hieu-le/active
- Server-side datatables methods provided by yajra/laravel-datatables
- Image manipulation by intervention/image
- Logs visualization by arcanedev/log-viewer
- Gravatar import by thomaswelton/laravel-gravatar
- Javascript session keep-alive
- Localized English / French / Spanish / Turkish
- In order to install Laravel/AdminLTE Boilerplate run :
composer require sebastienheyd/boilerplate
- Run the command below to publish assets, views, lang files, ...
php artisan vendor:publish --provider="Sebastienheyd\Boilerplate\BoilerplateServiceProvider"
- After you set your database parameters in your
.envfile run :
php artisan migrate
Optional
If you want to quickly test your Laravel application.
php artisan serve
Now you can point your browser to http://localhost:8000/admin
Configuration files can be found in config/boilerplate folder.
app.php: url admin prefix, backend locale, redirection after login (see comments in file), ...auth.php: overriding ofconfig/auth.phpto use boilerplate models instead of default Laravel models. Allow you to define if users can register from login page and which role will be assigned to a new user.laratrust.php: overriding of Laratrust (package santigarcor/laratrust) default config.menu.php: dashboard to use and menu classestheme.php: backend theme configuration
You can define your own controller to display the dashboard by setting the dashboard parameter in config/boilerplate/menu.php.
To add an item to the menu, nothing simpler, use the artisan boilerplate:menuitem command provided with boilerplate.
This command will generate the classes needed to generate the menu item in the app/Menu folder.
php artisan boilerplate:menuitem {name} {-s} {-o=100}| option / argument | description |
|---|---|
| name | Class name to generate |
| -s --submenu | Menu item must have sub item(s) |
| -o --order | Menu item order in the backend menu |
Once generated, the files can be edited to customize the item.
You can also add your own providers by adding their classnames to the array of providers in the configuration file
config/boilerplate/menu.php. This can be useful if you don't want to use the default directory app/Menu in your
application.
For package developers, menu items providers can be added by using the boilerplate.menu.items singleton in your
package service provider. Example :
public function boot()
{
app('boilerplate.menu.items')->registerMenuItem([
Users::class,
Logs::class,
]);
}For more information, see the documentation of the following packages:
By default, only jQuery, Bootstrap, Font Awesome and AdminLTE scripts and styles are loaded.
To load and use plugins like Datatables, Date Picker, TinyMCE, ... you can use "loaders". These are blade templates prepared to add the loading of scripts and styles for a plugin.
For example, you want to use a datepicker on a text field :
@include('boilerplate::load.datepicker')
@push('js')
<script>
$('.datepicker').datepicker();
</script>
@endpushHere @include('boilerplate::load.datepicker') will load scripts and styles to allow usage of datepicker. After that
you can push your scripts on the js stack (or styles on the css stack).
Available loaders are :
Some plugins are loaded by default :
You can see examples on the default dashboard.
By default the language used by boilerplate is the application language declared into config/app.php (locale). You can
define another language only for the back-office by setting locale parameter in config/boilerplate/app.php.
Supported language are English, French, Spanish and Turkish.
When you run php artisan vendor:publish --provider="Sebastienheyd\Boilerplate\BoilerplateServiceProvider", only the
language files for form validation are copied for supported languages. Thanks to
Laravel-Lang/lang package !
You can translate into a language not yet supported by copying the
src/resources/lang/boilerplate folder content into
resources/lang/vendor/boilerplate folder. After that, copy or rename one of the language folders in the new language
folder to create. All you have to do is translate. If you want to share the language you have added, don't hesitate to
make a pull request.
Routes are loaded from the file boilerplate.php.
A default prefix admin is set into the config file app.php, this is why
boilerplate is accessible by /admin url. You can set an empty prefix if you remove the default route / defined in
routes/web.php
Boilerplate comes with assets such as Javascript, CSS, and images. Since you typically will need to overwrite the assets
every time the package is updated, you may use the --force flag :
php artisan vendor:publish --provider="Sebastienheyd\Boilerplate\BoilerplateServiceProvider" --tag=public --force
To auto update assets each time package is updated, you can add this command to post-autoload-dump into the
file composer.json at the root of your project.
{
"scripts": {
"post-autoload-dump": [
"@php artisan vendor:publish --provider=\"Sebastienheyd\\Boilerplate\\BoilerplateServiceProvider\" --tag=public --force -q",
]
}
}If needed, you can force update for these tags : config, lang, public
| tag | description | destination path |
|---|---|---|
| config | Configuration files | app/config/boilerplate |
| lang | Laravel default lang files for form validation | ressources/lang |
| public | Public assets, you must update it after each package update | public/assets/vendor/boilerplate |
This package is delivered with a Makefile used to launch checks for the respect of coding standards and the unit tests
Just call make to see the list of commands.
This package is also delivered with functional tests using Laravel Dusk
After installing Laravel, Laravel Dusk and configuring your database, you can start the tests with the following command :
php artisan dusk vendor/sebastienheyd/boilerplate/tests/DuskTest.php
Important : Never launch tests with Laravel Dusk if you have data in your database, Dusk will wipeout all your datas
Since Laravel 5.8, this package use Carbon 2 instead of Jenssegers/Date to translate dates.
Date format now use the format of momentjs. To translate your dates, you must now use the Carbon 2 class method isoFormat
instead of format
MySQL < v5.7.7 or MariaDB
When you run php artisan migrate and you hit this error :
[PDOException]
SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes
This is an error from a change since Laravel 5.4 : see here
To correct this, two possibilities :
-
Define
utf8instead ofutf8mb4as default database charset andutf8_unicode_ciinstead ofutf8mb4_unicode_cias default database collation. -
Edit your
app/Providers/AppServiceProvider.phpfile and define a default string inside the boot method :
use Illuminate\Support\Facades\Schema;
public function boot()
{
Schema::defaultStringLength(191);
}Please see contributing.md for details and a todolist.
This package is free software distributed under the terms of the MIT license.
This project is made with PhpStorm and supported by JetBrains
