README

LaradminLTE: AdminLTE v4 for Laravel

LaradminLTE is a Laravel package that seamlessly integrates the powerful AdminLTE v4 dashboard template into Laravel (v10 or higher). Designed for modern web applications, this package provides a fast and flexible way to build responsive, maintainable, and feature-rich admin panels by using a Laravel Blade component to quick access the layout and configuration files to customize it.

Caution

Active Development: LaradminLTE is currently under active development. Features, configuration options, and behavior are subject to change until the first stable release.

Requirements

Laravel: 10 or higher
PHP: 8.1 or higher

Installation and Setup

Follow these steps to install, configure, and test LaradminLTE in your Laravel application:

1. Install the Package

Use Composer to add the package to your Laravel project:

composer require dfsmania/laradminlte:dev-main --prefer-stable

2. Publish Package Resources

Run the following commands to publish the basic package's assets and configuration files:

php artisan vendor:publish --provider="DFSmania\LaradminLte\LaradminLteServiceProvider" --tag="assets"
php artisan vendor:publish --provider="DFSmania\LaradminLte\LaradminLteServiceProvider" --tag="config"

3. Create a Test Route and View

Set up a test route in your routes/web.php file:

Route::get('ladmin_welcome', function () {
    return view('laradminlte-welcome');
});

Next, create a Blade view to test the package's functionality. The package provides a main blade component that should be used to render the layout. As example, save the following content in resources/views/laradminlte-welcome.blade.php:

<x-ladmin-panel>

    {{-- Setup the content header --}}
    <x-slot name="contentHeader">
        <div class="row">
            <div class="col-12">
                <h3 class="fw-bold">
                    <i class="bi bi-heart-fill text-danger"></i>
                    Welcome to LaradminLTE!
                </h3>
            </div>
        </div>
    </x-slot>

    {{-- Setup the content body --}}
    <div class="row">
        <div class="col-12">
            <i class="bi bi-rocket-takeoff-fill fs-5 text-primary"></i>
            Now, start building your next administration panel with ease and flexibility.
        </div>
    </div>

</x-ladmin-panel>

Finally, to visualize the admin layout, open your browser and navigate to:

http://your-app.test/ladmin_welcome

Replace your-app.test with your local development URL. You should now see the default admin layout rendered using the package’s out-of-the-box configuration:

4. Customize Configuration

Explore and modify the package's configuration files to suit your needs:

config/ladmin.php: General settings for the admin panel.
config/ladmin_menu.php: Define the menu structure.
config/ladmin_plugins.php: Manage plugins and extensions.

For detailed usage instructions, advanced configuration options, and customization guides, refer to the Official LaradminLTE Documentation.

dfsmania / laradminlte

Maintainers

Details