kevinpapst/adminlte-bundle

Admin theme bundle for Symfony 4 based on AdminLTE 2.4.8 with FOSUserBundle support

Installs: 33 631

Dependents: 6

Suggesters: 0

Stars: 102

Watchers: 13

Forks: 27

Open Issues: 3

Type:symfony-bundle

2.8.6 2019-09-16 15:01 UTC

README

Latest Stable Version Build Status Total Downloads License

AdminLTE Bundle for Symfony 4

This repository contains an upgraded version of the AvanzuAdminThemeBundle, bringing the AdminLTE theme to Symfony 4.

Introduction

Minimum requirements

  • Symfony 4.0
  • PHP 7.1.3
  • Twig 2.0

Features

Some of the main features of this theme bundle:

  • Two main layouts for main application and security (login, forgot password, register account...)
  • Support for Symfony 4.x
  • Support for KNPMenuBundle
  • Support for FOSUserBundle
  • Webpack-Encore support for building assets
  • Event-driven handling of menu entries, tasks and notifications
  • Translations for: english, german, italian, czech, russian, arabic, japanese, swedish, portuguese, dutch, french (please help translating it to more languages)
  • Based on AdminLTE 2.4.8
  • Using FontAwesome 5

Installation with Symfony Flex

Installation using Symfony flex:

composer config extra.symfony.allow-contrib true
composer req "kevinpapst/adminlte-bundle:^2.0"

Installation with Composer

Installation using the "traditional" composer approach:

   composer require kevinpapst/adminlte-bundle ^2.0

Afterwards copy the default config to your config/packages/ directory:

cp vendor/kevinpapst/adminlte-bundle/config/packages/admin_lte.yaml config/packages/

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

<?php

return [
    // ...
    KevinPapst\AdminLTEBundle\AdminLTEBundle::class => ['all' => true],
];

Difference between AdminLTEBundle and AvanzuAdminThemeBundle

First and foremost: the original repository has a strong backward compatibility in mind, maintenance is only done if Symfony 2 and 3 compatibility is kept (e.g. here).

That means you don't get the new shiny stuff for SF4. As I work on a Symfony 4 project, utilizing webpack-encore I needed a solution.

First I tried to sent PRs for the original repository, but those were not always accepted eg. here. As I really needed an upgraded version, I tried to manage a branch in a fork for a couple of weeks, but that wasn't working well and I found myself overwriting more and more stuff in my project until there was a point were I had to choose between:

  1. doing all the changes in my project
  2. doing the changes in my forked repository and having "dev-" entries in my composer.json
  3. cleanup the fork, merge it with my project changes and release it for the community

The choice 3 was easy and obvious for me: I am doing the work now in this repository with a fresh start and the chance for backward-compatibility breaks (for the users migrating from the AdminThemeBundle).

Main differences

This repository was created from the original master, but with the following PRs merged on top:

  • Auto discovery for commands (see #215)
  • Symfony4 compatibility (see #215)
  • Dynamic config options (see #217)

And a lot of other changes which I added in this repository:

  • upgraded to AdminLTE 2.4.8
  • added support for FOSUserBundle
  • added Symfony Flex recipe for easier integration
  • using Webpack-Encore for compiling frontend-assets
  • fixed KNPMenu integration
  • replaced AliasRouting with simpler version
  • changed namespaces to allow co-existence with AdminThemeBundle for migration
  • changed and extended default configuration
  • huge cleanup of the codebase
  • changed all twig block-names (with additional layout shim files for migration)
  • changed control-sidebar, content is now configurable from admin_lte.yaml or the ContextHelper
  • a Demo application as living documentation for first time users and easier testing
  • updated composer.json to reflect more up-to-date bundle dependencies
  • introduction of unit tests, phpstan and code-style rules (all checked by Travis)

Migration from AvanzuAdminTheme

Be aware: I decided to change some project internals and got rid of some features from the original AdminThemeBundle. I found the all-in-one solution to be more problematic then helpful at several places, so I took the chance to update it to my own interpretation of a theme bundle.

If you previously used the AvanzuAdminTheme you will not be able to "just replace" the composer package. Plan ahead, you will need (depending on the size of your project) a couple of hours for the migration.

I migrated my own project within ~4 hours, but I had to move a lot of the customization to the bundle (e.g. the webpack-encore build) in the same time. See the PRs #202 and #206 for migration examples.

License and contributors

Published under the MIT, read the LICENSE file for more information.

This repository is based on the work of AdminThemeBundle, please check their contributor list as well and give them a star!