ashtokalo/yii2-adminlte

Module to extend yii2 application with AdminLTE interface.

dev-master 2022-06-27 18:54 UTC

Requires

• almasaeed2010/adminlte: ~3.2
• nullref/yii2-datatables: ~1.1
• yiisoft/yii2: ^2.0

MIT

• Alexey Shtokalo

README

AdminLTE for Yii2 is a module for Yii2 framework to get simple administration interface based on AdminLTE fully responsive administration template and on Bootstrap 4.6 framework and also the JS/jQuery plugin.

Warning! This module is under development! Anything might be changed or even removed! There are no documentation other than comments in code!

Quick start

There are multiple ways to install the module, but composer from repository would be preferred:

composer require ashtokalo\yii2-adminlte

Assume you already have Yii2 application, so the only changes you need are:

1. Add module to configuration of web application:

'modules' => [
    // here the other modules
    'adminlte' => [
        'class' => \ashtokalo\yii2\adminlte\Module::class,
    ],
],

1. Add the module to bootstrap of web application:

'bootstrap' => [
    // here the other modules
    'adminlte',
],

1. Configure sidebar and navbar as web application components:

'components' => [
    // here the other components
    'sidebar' => [
        'class' => \ashtokalo\yii2\adminlte\widgets\Sidebar::class,
        'items' => [
            // here the items of your sidebar
        ],
    ],
    'navbar' => [
        'class' => \ashtokalo\yii2\adminlte\widgets\Navbar::class,
        'items' => [
            // here the items of your navbar
        ],
    ],
],

Contributing

Contributions are welcome and will be fully credited.

You can take the code and run test application:

git clone https://github.com/ashtokalo/yii2-adminlte.git
cd yii2-adminlte
composer update
cd test/app
./yii serve &
xdg-open http://localhost:8080

Only contributions via Pull Requests on Github is accepted:

• PSR-2 Coding Standard

• Document any change in behaviour - Make sure the readme.txt and any other relevant documentation are kept up-to-date.

• Create feature branches - Don't ask us to pull from your master branch.

• One pull request per feature - If you want to do more than one thing, send multiple pull requests.

• Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

License

AdminLTE for Yii2 is an open source project by Alexey Shtokalo that is licensed under MIT.

Credits

• AdminLTE