Download the PHP package bcartfall/adminlte-laravel without Composer

IMPORTANT NOTE: This project is looking for a maintainer please email [email protected] if you are interested.

AdminLTE template Laravel 5 package

A Laravel 5 package that switch default Laravel scaffolding / boilerplate to AdminLTE template with Bootstrap 3.0 and Pratt Landing Page

See demo here:

http://demo.adminlte.acacha.org/

If you are looking for the Laravel 4 version, use 0.1.5 version/tag and see OLD-README.md

Installation & use

So easy to install! Install globally with composer:

And convert any Laravel installation to AdminLTE/Pratt with:

Enjoy! If you wish you can use llum to start your app:

To start using you Laravel with AdminLTE. Llum will configure database (sqlite),execute migrations, install devtools and serve for you.

More info about llum commands in Github Acacha/llum.

Requirements

This packages use (no need to install):

• Composer
• Laravel
• AdminLTE. You can see and AdminLTE theme preview at: http://almsaeedstudio.com/preview/
• Pratt. Pratt Landing Page
• Acacha/user: providing boosted Laravel Users. This could be optional through configuration.
• acacha/helpers : Extra helpers for Laravel provided by acacha.
• creativeorange/gravatar: Gravatar support for user's profile images. This could be optional through configuration.
• league/flysystem : Filesystem support.
• acacha/forms : Javascript Form objects implementation.
• acacha/llum. Easy Laravel packages installation (and other tasks). Used to modify config/app.php file without using stubs (so you changes to this file would be respected)
• thephpleague/skeleton. This package use/has been adapted to use the phpleague skeleton.
• Acacha llum requires GNU sed. on MAC OS install GNU sed with:

This package assumes that you have in path your composer bin folder:

For example adding this line:

to your ~/.bashrc file

Note: in some systems the path coul be diferent for example:

Please be sure to check you environment.

Optional requirements

• Laravel menu: only used with command adminlte:menu that replaces default adminlte menu with a menu with spatie/laravel-menu support.

Laravel 5.6

This package works smoothly with Laravel 5.6 with 6.0+ versions.

Laravel 5.5

This package now use new Laravel 5.5 feature Package Auto Discover.

Laravel 5.4

Use 4.1.23 version of this package!

Laravel 5.4 manual installation

Follow the typical Laravel package installation steps:

 laravel new laravel-with-admin-lte
 cd laravel-with-admin-lte

Add admin-lte Laravel package with:

 composer require "acacha/admin-lte-template-laravel:4.*"

To register the Service Provider edit config/app.php file and add to providers array:

To Register Alias edit config/app.php file and add to alias array:

Publish files with:

Use force to overwrite Laravel Scaffolding packages. That's all! Open the Laravel project in your browser or homestead machine and enjoy!

Laravel 5.3

Use branch 3.x for Laravel 5.3 version.

Laravel 5.2

Also you can use for previous version of Laravel (5.2) :

Laravel 5.1 notes

By default Laravel 5.1 does not include default auth routes. Versions > 1.0 < 2.0 of this package add the necessary routes for you

See old README file file for notes of which routes are registered.

Installation

First install Laravel (http://laravel.com/docs/5.0/installation) and then Create a new Laravel project:

 laravel new laravel-with-admin-lte
 cd laravel-with-admin-lte

Add admin-lte Laravel package with:

 composer require "acacha/admin-lte-template-laravel:1.*"

Register ServiceProvider editing config/app.php file and adding to providers array:

// AdminLTE template provider         
Acacha\AdminLTETemplateLaravel\app\Providers\AdminLTETemplateServiceProvider::class,

Publish files with:

 php artisan vendor:publish --force --provider="Acacha\AdminLTETemplateLaravel\app\Providers\AdminLTETemplateServiceProvider"

Use force to overwrite Laravel Scaffolding packages. That's all! Open the Laravel project in your browser or homestead machine and enjoy!

Note: use the following for Laravel <5.1 versions:

 // AdminLTE template provider
 'Acacha\AdminLTETemplateLaravel\app\Providers\AdminLTETemplateServiceProvider',

Laravel Routes

This package installs Laravel routes that you will not find them at routes.php file. The routes installed by package would be find at file:

https://github.com/acacha/adminlte-laravel/blob/master/src/Http/routes.php

A file included by AdminLTETemplateServiceProvider:

https://github.com/acacha/adminlte-laravel/blob/master/src/Providers/AdminLTETemplateServiceProvider.php

You can override this routes by changing order of ServiceProviders in config/app.php file so if you put:

After

Your routes in routes.php file will override default adminlte-laravel routes.

Also you can install manually the routes in routes.php file. Adminlte-laravel use same routes as Laravel make:auth command use, see:

https://github.com/laravel/framework/blob/5.2/src/Illuminate/Auth/Console/stubs/make/routes.stub

so you can add this lines to routes.php file:

And disable AdminLTETemplateServiceProvider in config/app.php file ( take into account that Adminte-laravel Facades and custom commands will not be available).

See issue https://github.com/acacha/adminlte-laravel/issues/69 for more info

First steps, database creation, migrations and login

Once package installed you have to follow the usual steps of any laravel project to Login to the admin interface:

• Create a database. I recommend the use of laravel Homestead ()
• Create/check .env file and configure database access (database name, password, etc)
• Run migrations with command $ php artisan migrate
• Registera a first user and Login with it

AdminLTE

AdminLTE is a Free Premium Admin control Panel Theme That Is Based On Bootstrap 3.x created by Abdullah Almsaeed. See:

https://github.com/almasaeed2010/AdminLTE

Avatar/Gravatar

Adminlte-laravel supports global recognized avatar (http://gravatar.com) using package creativeorange/gravatar (https://github.com/creativeorange/gravatar).

Artisan Commands

make:view

This commands adds a view to resources/views folder using default adminlte layout:

make:menu

This commands adds a menu entry to file config/menu.php:

Example:

make:route

This commands adds a route to routes file using:

For example you can add a route routes/web.php file with URI /about using:

This commands add this entry to routes/web.php

You can create 3 types of routes with option type:

• regular: routes using a clousure with a simple return view command. This is the default one
• controller: routes using a controller.
• resource: routes using a resource controller.

Examples:

this adds the following:

to file routes/web.php. You can choose the controller name and method with:

If you want to create a resource controller:

this adds the following:

to file routes/web.php.

You can also create routes with other HTTP methods using option method:

You can also add routes to api using option api:

Then the routes will be added to routes/api.php.

Finally use option -a to add actions after route creation:

Last command also create a view with name about.blade.php. Using:

Will create a Controller file with name AboutController and method index.

You can consult all options with:

adminlte:publish | adminlte-laravel:publish

This command is already executed during installation you can (re)execute manually with:

Publish all necessary files from package to Laravel project.

adminlte:sidebar | adminlte-laravel:sidebar

Only publish package sidebar to Laravel project allowing to customize sidebar:

Note: sidebar is already published when you use adminlte-laravel install command.

adminlte:menu | adminlte-laravel:menu

Replaces sidebar view with a sidebar using spatie/laravel-menu:

This command also installs spatie/laravel-menu package and creates a default menu located config/menu.php.

IMPORTANT: Spatie Laravel Menu required PHP7.0 or superior to work

adminlte-laravel:admin | adminlte:admin

Executes make:adminUserSeeder artisan command (see next section) an executes seed. This command adds a default admin user to database.

This command use (if exists) environment variables (.env file) ADMIN_USER, ADMIN_EMAIL and ADMIN_PWD. If this env variables does not exists then user git config (~/.gitconfig) to obtain data and if this info does not exists use Admin ([email protected]) and password 123456 as default.

make:adminUserSeeder

Create a new seed to add admin user to database. Use:

Social Login/Register with acacha/laravel-social

It's a cinch to add (optional) Social Login/Register support to Laravel Adminlte using acacha/laravel-social package. Execute in your project root folder:

Follow the wizard to configure your social providers Oauth data and enjoy!

More info at https://github.com/acacha/laravel-social.

How to remove social Login?

Remove line

in files resources/views/auth/login.blade.php and register.blade.php

Roadmap

• Add email html templates
• Add breadcrumps with: https://github.com/davejamesmiller/laravel-breadcrumbs

Documentation TODO

• Gulp file provided to compile Boostrap and AdminLTE less files
• Partial views (html header, content header, footer, etc.) to easily reuse code

Packagist

https://packagist.org/packages/acacha/admin-lte-template-laravel

More info

http://acacha.org/mediawiki/AdminLTE#adminlte-laravel

Tests

Testing this package

Use phpunit on run composer script test:

Testing laravel project once this package is installed

Once this package is installed in a Laravel project some tests are installed to test package features. There are two kind of tests Feature/Unit tests and Browser tests. To execute Feature/Unit tests execute:

In a new created laravel project with acacha-admintle.laravel installed to test that package is installed correctly. You can also execute Browser tests with Laravel Dusk (please install first manually Dusk package following https://laravel.com/docs/master/dusk):

You can also test this package in a sandbox without need to install. Run script:

Localization

All strings are localized using Laravel localization support: https://laravel.com/docs/master/localization

In your config/app.php file you can change locale to change language. You can install only localized files using tag adminlte_lang:

The following languages are supported by default on this package: English, Catalan, Spanish, Dutch and Brazilian Portuguese. Please feel free to submit a new pull request with another languages if you wish.

Troubleshooting

GNU sed on MAC OS

NOTA: not needed in Laravel 5.5+

Acacha llum need GNU sed to work so replace BSD sed with GNU sed using:

Check you version of sed with:

sed GNU version path is:

Instead of default path of BSD sed (installed by default on MAC OS):

More info at https://github.com/acacha/adminlte-laravel/issues/58

How to use username at login instead of email

Execute command:

And then you can use username instead of email for login.

NOTE: when we are using login by username if login by usernames fails then system try to use the introduced username as an email for login. So users can also login using email.

To come back to email login remove field option from config/auth.php file:

NOTE: Migration required to add username field to users table requires:

Default domain for username registration

Optionally you can define a default domain name for username login. Add domain option:

to file config/auth.php. Then if an user tries to login with no domain the default domain will be appended whe logging.

So with previous example you can type at login:

and system/javascript will replace that with:

Vue

Laravel adminlte package by default publish Laravel translations into Javascript/Vue.js adding to HTML header the following script:

This script is located in partial blade file (vendor/acacha/admin-lte-template-laravel/resources/views/layouts/partials/htmlheader.blade.php)

So global variable window.trans contains all Laravel translations at can be used in any Javascript file.

Also in file resources/assets/js/bootstrap.js code section:

Allows using directly the trans function in vue templates:

Also you can use inside Vue components code:

Laravel Adminlte messages ara available using prefix adminlte_lang_message:

Feel free to remove/adapt this file to your needs.

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONDUCT for details.

Security

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

Credits

• Sergi Tur Badenas
• All Contributors

License

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

See also

https://github.com/acacha/adminlte-laravel-installer