README.md

Backpack\Base

Laravel BackPack's central package, which includes:

• admin login interface, using AdminLTE;
• basic menu;
• pretty error pages;
• alerts system (notification bubbles);

Subscribe to the newsletter to be announced of any major updates or breaking changes.

Install

1. Run in your terminal:

$ composer require backpack/base

2. Add the service providers in config/app.php:

Backpack\Base\BaseServiceProvider::class,
'Prologue\Alerts\AlertsServiceProvider',

3. Add the alias to the list of aliases in config/app.php:

'Alert' => 'Prologue\Alerts\Facades\Alert',

4. Then run a few commands in the terminal:

$ rm -rf app/Http/Controllers/Auth #deletes laravel's demo auth controllers
$ php artisan vendor:publish --provider="Backpack\Base\BaseServiceProvider" #publishes configs, langs, views and AdminLTE files
$ php artisan vendor:publish --provider="Prologue\Alerts\AlertsServiceProvider" # publish config for notifications - prologue/alerts
$ php artisan migrate #generates users table (using Laravel's default migrations)

5. [optional] Change values in config/backpack/base.php to make the admin panel your own. Change menu color, project name, developer name etc.

6. [optional] If you want to be able to use the Reset Password functionality, you need to specify to Laravel to use the Backpack email for this. At the end of your \config\auth.php file, change:

'passwords' => [
        'users' => [
            'provider' => 'users',
            'email' => 'backpack::auth.emails.password', // <--- change is here
            'table' => 'password_resets',
            'expire' => 60,
        ],
    ],

Usage

1. Register a new user at yourappname/admin/register
2. Your admin panel will be available at yourappname/admin or yourappname/login
3. [optional] If you're building an admin panel, you should close the registration. In config/backpack/base.php look for "registration_open" and change it to false.

Change log

Please see CHANGELOG for more information what has changed recently.

Todos

// TODO - instruct developer on how to modify/extend the AuthController and PasswordController and/or provide example

Testing

// TODO

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Cristian Tabacitu
• All Contributors

License

The MIT License (MIT). Please see License File for more information.