Installation Guide

Integrate the Bfg Admin package into your Laravel application by following the straightforward instructions outlined below. This process involves using Composer, the PHP package manager, to install the package and then configuring your application to utilize it.

Prerequisites

Ensure you have Laravel installed in your project before proceeding with the Bfg Admin installation. For Laravel installation instructions, refer to the official Laravel documentation.

Step 1: Install Bfg Admin via Composer

To install the Bfg Admin package, use Composer by executing the following command in your terminal within your project directory:

composer require bfg/admin:^6

This command downloads and installs the Bfg Admin package as a dependency for your project.

Step 2: Configure Environment Variables

After installing the package, it is essential to configure specific environment variables in your project's .env file to ensure the admin panel functions correctly. This step is crucial for setting up the connection between your application and its database, as the admin panel relies on database interactions for its operations.

Step 3: Install Bfg Admin

With the Bfg Admin package installed and the environment variables set up, you can now install the admin panel extension in your Laravel application by running:

php artisan admin:install

This command deploys all required migrations and admin files to your Laravel application folder, setting up the admin panel for your project.

By following these steps, you will successfully integrate the Bfg Admin panel into your Laravel project, allowing you to utilize its comprehensive features for efficient application administration and management.

Step 4: Create a Controller

To create a new controller for your model, use the following command:

php artisan admin:controller UsersController --model=User

This command generates a new controller named UsersController that is linked to the User model, providing you with a ready-to-use controller for managing user data in your application.

To display the newly created controller in the admin panel navigation, add it to the app/Admin/Navigator.php file under the handle section. This step ensures that the controller is accessible from the admin panel interface, allowing you to manage the associated model data efficiently.

use App\Admin\Controllers\UsersController;
...
    public function handle() : void
    {
        ...
        
        $this->item('Users')
            ->resource('users', UsersController::class)
            ->icon_users();
            
        ...    
    }
...

Step 6: Access the Admin Panel

If your server is not already running, use the following command to start Laravel's built-in server:

php artisan serve

Open your browser and go to the URL that Laravel gives you (usually http://127.0.0.1:8000/bfg) to log into the admin panel using the credentials of the user you created. Enter standard user admin: admin

Last modified: 03 June 2024

BFG Admin Documentation 6.4 Help