allay/base

Allay's base package, which offers a bare-bones website admin package, built on Laravel and AdminLTE theme

1.1.4 2017-04-25 20:48 UTC

This package is not auto-updated.

Last update: 2024-11-09 21:08:52 UTC


README

The Allay base package provides a bare-bones administrator interface.

  1. User/admin interface, using AdminLTE
  2. Basic menu
  3. Error messages & alerts

Notice!

This package is not production ready. It does not follow a release cycle.

Ignore the 1.0 release included in this repository. All development is done on master until a production release is completed.

What is this?

This package is forked from the last MIT-licensed commit of Laravel Backpack, citing two reasons:

  1. Backpack went the freemium route. Allay will always be MIT.
  2. Features will (and already have) diverged from the Backpack repository.

Should I Contribute?

Yes. This package is developed full-time, let's build something great and free together.

Install on Laravel 5.3

  1. Run in your terminal:
$ composer require allay/base
  1. Add the service providers in config/app.php:
Allay\Base\BaseServiceProvider::class,
  1. Then run a few commands in the terminal:
# publish configs, langs, views and AdminLTE files
$ php artisan vendor:publish --provider="Allay\Base\BaseServiceProvider"

# publish config for notifications - prologue/alerts
$ php artisan vendor:publish --provider="Prologue\Alerts\AlertsServiceProvider"

# generates users table (using Laravel's default migrations)
$ php artisan migrate
  1. Make sure the reset password emails have the correct reset link by adding these to your User model:
  • before class name use Allay\Base\app\Notifications\ResetPasswordNotification as ResetPasswordNotification;
  • as a method inside the User class:
  /**
   * Send the password reset notification.
   *
   * @param  string  $token
   * @return void
   */
  public function sendPasswordResetNotification($token)
  {
      $this->notify(new ResetPasswordNotification($token));
  }
  1. [optional] Change values in config/allay/base.php to make the admin panel your own. Change menu color, project name, developer name etc.

Usage

Use the following default routes:

  1. /admin/register - Register your user
  2. /admin or /login - Login to your administration panel
  3. Consider closing registration or augmenting it once the admin user is created.

Security

If you discover any security related issues, please email zlschuessler@gmail.com instead of using the issue tracker.

Credits

  • Zachary Schuessler - Vice package maintainer
  • Cristian Tabacitu - Laravel Backpack maintainer, which Allay was forked from.

License

The MIT License (MIT).

See license.md file for more information: