sebastienheyd/boilerplate

Laravel Boilerplate based on AdminLTE 3 with user management, roles, permissions, logs viewer, ...

7.17.3 2022-08-02 13:28 UTC

README

Packagist Build Status StyleCI Scrutinizer Code Quality Laravel Nb downloads MIT License

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 :

68747470733a2f2f73656261737469656e686579642e6769746875622e696f2f626f696c6572706c6174652f6173736574732f696d672f6c6f67696e2e706e67 68747470733a2f2f73656261737469656e686579642e6769746875622e696f2f626f696c6572706c6174652f6173736574732f696d672f6164645f757365722e706e67 68747470733a2f2f73656261737469656e686579642e6769746875622e696f2f626f696c6572706c6174652f6173736574732f696d672f726f6c652e706e67 68747470733a2f2f73656261737469656e686579642e6769746875622e696f2f626f696c6572706c6174652f6173736574732f696d672f6c6f67732e706e67

Documentation

The documentation is readable on Github pages

Features

Installation

  1. In order to install Laravel/AdminLTE Boilerplate run :
composer require sebastienheyd/boilerplate
  1. Run the command below to publish assets, lang and configuration files
php artisan vendor:publish --tag=boilerplate
  1. 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

JetBrains Logo