Current Location: Home> Latest Articles> Laravel-Admin Automatic Module Generation Tutorial and Basic Configuration Methods

Laravel-Admin Automatic Module Generation Tutorial and Basic Configuration Methods

gitbox 2025-07-03

Introduction

Laravel-Admin is a backend management system development tool based on the Laravel framework, designed to help developers quickly build feature-rich backend systems. This article will guide you through how to use Laravel-Admin to automatically generate modules and provide related basic configuration methods to help you use the framework more efficiently.

Install Laravel-Admin

Before starting, you need to install Laravel-Admin into your project. Below are the installation steps:

Create a Laravel Project

First, create a Laravel project. Open the command-line tool, navigate to the directory where you want to create the project, and run the following command:

composer create-project --prefer-dist laravel/laravel your-project-name

Replace "your-project-name" with the name of your project.

Install Laravel-Admin

In the root directory of your project, run the following command to install Laravel-Admin:

composer require encore/laravel-admin

After the installation is complete, you need to publish Laravel-Admin's resource files by running the following command:

php artisan vendor:publish --provider="Encore\Admin\AdminServiceProvider"

Automatically Generate Modules

Laravel-Admin provides a command to automatically generate the code for modules. By running the following command, you can create a simple module:

php artisan admin:make User --model=App\User

This command will generate a module named "User" and create a "users" table in the database. Next, run the following command to migrate the database:

php artisan migrate

Configure Laravel-Admin

Configuring Laravel-Admin is one of the key steps in using the framework. Below are some common configuration methods:

Modify the Login Page

You can customize the login page's background image by modifying the `login_background_image` item in the `config/admin.php` configuration file.

Configure the Navigation Menu

You can define the navigation menu in the `config/admin.php` file. Here is an example:

'menu' => [
    [
        'title' => 'Dashboard',
        'icon' => 'fa-dashboard',
        'uri' => '/',
    ],
    [
        'title' => 'User',
        'icon' => 'fa-user',
        'uri' => 'user',
    ],
]

In the example above, we have defined two menu items: one named "Dashboard" which links to the `/` route, and another named "User" which links to the `/user` route.

Customize Model Display

Laravel-Admin uses the `toString()` method of a model as the default display for the model list. If you want to customize how the model is displayed, you can add a `__toString()` method to the model. For example:

public function __toString()
{
    return $this->name;
}

By using this method, the model list will display based on the `name` attribute.

Conclusion

This article explained how to use Laravel-Admin to automatically generate modules and provided some basic configuration methods. By following these steps, developers can use Laravel-Admin more efficiently and quickly set up a backend management system. I hope this article was helpful to you!