README

This package serves as a basis for quickly creating a back-office. It includes profile creation and his management, user management, roles, permissions, log viewing and ready to use components.

It also makes it easy to add other packages to extend the features, have a look to sebastienheyd/boilerplate-packager to quickly build your own package for boilerplate.

Other packages to extend the features :

Documentation

The documentation is readable on Github pages

Features

Configurable backend theme and components for AdminLTE 3
Css framework Bootstrap 4
Icons by Font Awesome 5
Role-based permissions support 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 creativeorange/gravatar
Default languages support by overtrue/laravel-lang and Laravel-Lang/lang
Javascript session keep-alive
Localized

Installation

In order to install Laravel/AdminLTE Boilerplate run :

composer require sebastienheyd/boilerplate

Run the command below to publish assets, lang and configuration files

php artisan vendor:publish --tag=boilerplate

After you set your database parameters 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

Package update (Laravel < 8.6.9)

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 --tag=boilerplate-public --force

To auto update assets each time package is updated, you can add this command to post-update-cmd into the file composer.json at the root of your project.

{
    "scripts": {
        "post-update-cmd": [
            "@php artisan vendor:publish --tag=boilerplate-public --force --ansi"
        ]
    }
}

Tests / Coding standards

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.

Laravel Dusk functionnal tests

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

Contributing

Please see CONTRIBUTING.md for details and a todolist.

Credits

License

This package is free software distributed under the terms of the MIT license.

Special thanks

This project is made with PhpStorm and supported by JetBrains

sebastienheyd / boilerplate

Maintainers

Details