Download the PHP package dfsmania/laradminlte without Composer

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

Follow these steps to install LaradminLTE in your Laravel application:

1. Install the Package

Use Composer to add the package to your Laravel project:

Alternatively, if you want to install the latest development version, you can run:

2. Publish Required Package Resources

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

This command will publish the following elements to your application:

• Assets: The set of AdminLTE v4 distribution files (CSS, JS) and some images in the public/vendor/ladmin folder of your Laravel application.
• Config: The package configuration files in the config/ladmin folder of your Laravel application.

3. Other Publishable Resources (Optional)

Translations

Additionally, you can also publish the translation files if you want to customize them or add new languages:

Translation files will be published to the resources/lang/vendor/ladmin folder of your Laravel application.

Migrations

If you plan to use the built-in authentication scaffolding with the profile images feature, you should publish the package's migrations:

Migrations will be published to the database/migrations folder of your Laravel application. These migrations will create the necessary columns on the users table to support user profile images. You can run migrations by executing:

Usage

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

1. Create a Dedicated Route and View

Set up a route in your routes/web.php file, for example:

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 full admin layout. As example, save the following content in resources/views/laradminlte-welcome.blade.php:

• The title attribute of the main component sets the page title, which is automatically appended to your application's name and shown in the browser's title bar.
• The contentHeader slot is used to define the header section of the content area.
• The content body is placed directly within the main component tags (as the default slot of the component).
• The @push('js') directive allows you to add custom JavaScript code that will be included in the layout.
• The @push('css') directive can also be used to add custom CSS styles if needed.

2. Enable the Authentication Scaffolding (Optional)

[!IMPORTANT] To use the authentication scaffolding, you need to have the default Laravel's migrations for users already set up in your database. If this is not your case, then you can can install Laravel's default migrations by running: php artisan migrate.

If you want to use the built-in authentication scaffolding, make sure to have it enabled in the config/ladmin/auth.php file, and setup the home_path. The home_path is the place where users will be redirected after login. Then protect your routes using the auth middleware:

After this, all the routes within this group will require authentication to be accessed.

3. Test your Route/View

To test the admin panel, you first need to ensure that your Laravel application is running. You can start the development server using the following Artisan command:

Then, just open your browser and navigate to:

Replace your-app.test with your local development URL. If authentication is enabled, a login screen will appear. Then, you should see the default admin layout rendered using the package’s out-of-the-box configuration:

Finally, to define your admin panel menu entries, you can edit the config/ladmin/menu.php file. This file allows you to customize the sidebar and navbar menu structure and items according to your application's needs. Remember that each new menu entry that renders a page should provide a blade view that extends the main layout component (<x-ladmin-panel>) to ensure the admin layout is applied correctly.

4. Customize Configuration

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

• config/ladmin/main.php: General settings for the admin panel.
• config/ladmin/menu.php: Define the menu structure.
• config/ladmin/plugins.php: Manage plugins and extensions.
• config/ladmin/auth.php: Configure authentication scaffolding.

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

Contributing

Thank you for your interest in contributing to LaradminLTE! We welcome and appreciate all contributions that help improve the project. Please take a moment to review our guidelines on the Contribute page before getting started.