ak/voyager

A Laravel Admin Package for The Control Group to make your life easier and steer your project in the right direction

, _(*1)

, _(*2)

Voyager - The Missing Laravel Admin

Made with ❤️ by The Control Group, _(*3)

, _(*4)

Website & Documentation: https://laravelvoyager.com, _(*5)

Video Tutorial Here: https://laravelvoyager.com/academy/, _(*6)

Join our Slack chat: https://voyager-slack-invitation.herokuapp.com/, _(*7)

View the Voyager Cheat Sheet: https://voyager-cheatsheet.ulties.com/, _(*8)

Laravel Admin & BREAD System (Browse, Read, Edit, Add, & Delete), supporting Laravel 5.4 and newer!, _(*9)

Installation Steps

1. Require the Package

After creating your new Laravel application you can include the Voyager package with the following command:, _(*10)

composer require tcg/voyager

2. Add the DB Credentials & APP_URL

Next make sure to create a new database and add your database credentials to your .env file:, _(*11)

DB_HOST=localhost
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

You will also want to update your website URL inside of the APP_URL variable inside the .env file:, _(*12)

APP_URL=http://localhost:8000

Only if you are on Laravel 5.4 will you need to Add the Service Provider., _(*13)

3. Run The Installer

Lastly, we can install voyager. You can do this either with or without dummy data. The dummy data will include 1 admin account (if no users already exists), 1 demo page, 4 demo posts, 2 categories and 7 settings., _(*14)

To install Voyager without dummy simply run, _(*15)

php artisan voyager:install

If you prefer installing it with dummy run, _(*16)

php artisan voyager:install --with-dummy

Troubleshooting: Specified key was too long error. If you see this error message you have an outdated version of MySQL, use the following solution: https://laravel-news.com/laravel-5-4-key-too-long-error, _(*17)

And we're all good to go!, _(*18)

Start up a local development server with php artisan serve And, visit http://localhost:8000/admin., _(*19)

Creating an Admin User

If you did go ahead with the dummy data, a user should have been created for you with the following login credentials:, _(*20)

email: admin@admin.com
password: password, _(*21)

NOTE: Please note that a dummy user is only created if there are no current users in your database., _(*22)

If you did not go with the dummy user, you may wish to assign admin privileges to an existing user. This can easily be done by running this command:, _(*23)

php artisan voyager:admin your@email.com

If you did not install the dummy data and you wish to create a new admin user you can pass the --create flag, like so:, _(*24)

php artisan voyager:admin your@email.com --create

And you will be prompted for the user's name and password., _(*25)