sebastienheyd/boilerplate

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

7.24.2 2023-09-18 13:55 UTC

Requires

• php: >=7.4
• ext-curl: *
• arcanedev/log-viewer: ^5.0|^7.0|^8.0|^9.0|^10.0
• creativeorange/gravatar: ^1.0
• illuminate/support: ^6.0|^7.0|^8.0|^9.0|^10.0
• intervention/image: ^2.5
• laravel/ui: ^1.2|^2.0|^3.0|^4.0
• lavary/laravel-menu: ^1.7
• matthiasmullie/minify: ^1.3
• nesbot/carbon: ^2.0
• pusher/pusher-php-server: ^6.0|^7.0
• santigarcor/laratrust: ^6.0|^7.0
• sebastienheyd/active: ^1.0
• spatie/laravel-html: ^2.0|^3.0
• yajra/laravel-datatables-oracle: ^9.0|^10.0

Requires (Dev)

• doctrine/dbal: ^2.9|^3.0
• fakerphp/faker: ^1.20
• orchestra/testbench: ^4.0|^5.0|^6.0|^7.0|^8.0
• phpunit/php-code-coverage: ^7.0|^8.0|9.2.18
• phpunit/phpunit: ^7.0|^8.0|^9.0
• squizlabs/php_codesniffer: ^3.0

Suggests

• sebastienheyd/boilerplate-email-editor: Visual editor for e-mails for sebastienheyd/boilerplate
• sebastienheyd/boilerplate-media-manager: Media manager for sebastienheyd/boilerplate
• sebastienheyd/boilerplate-packager: Package manager for sebastienheyd/boilerplate

MIT

• Sébastien HEYD

• admin
• boilerplate
• backend
• laravel
• active
• AdminLTE
• laratrust
• laravelcollective

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 :

• sebastienheyd/boilerplate-media-manager
• sebastienheyd/boilerplate-email-editor

Documentation

The documentation is readable on Github pages

Features

• Configurable backend theme and components for AdminLTE 3
• Text generation with GPT in TinyMCE with the OpenAI API
• Customizable dashboard with widgets
• Css framework Bootstrap 4
• Icons by Font Awesome 5
• Role-based permissions support by santigarcor/laratrust
• Forms & Html helpers by spatie/laravel-html
• Menu dynamically builded by lavary/laravel-menu
• Menu items activated by sebastienheyd/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 from Laravel-Lang/lang
• Javascript session keep-alive
• Dark mode
• Localized

Installation

1. In order to install Laravel/AdminLTE Boilerplate run :

composer require sebastienheyd/boilerplate

1. Run the command below to publish assets 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.

Contributing

Please see CONTRIBUTING.md for details and a todolist.

Credits

• Sébastien HEYD
• All Contributors

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