Voyager - The Missing Laravel Admin

Made with ❤️ by The Control Group

Website & Documentation: https://voyager.devdojo.com/

---

Laravel Admin & BREAD System (Browse, Read, Edit, Add, & Delete), supporting Laravel 10.x and newer!

Want to use Laravel 10.x? Use Voyager 1.7

Introduction

Build a simple laravel development environment with docker-compose. Compatible with Windows(WSL2), macOS(M1) and Linux.

Installation Steps

1. Laravel install

1. Click Use this template
2. Git clone & change directory
3. Execute the following command

$ mkdir -p src
$ docker compose build
$ docker compose up -d
$ docker compose exec app composer create-project --prefer-dist laravel/laravel .
$ docker compose exec app php artisan key:generate
$ docker compose exec app php artisan storage:link
$ docker compose exec app chmod -R 777 storage bootstrap/cache
$ docker compose exec app php artisan migrate

http://localhost

2. Laravel setup

https://blog.desdelinux.net/vi/Makefile-l%C3%A0-g%C3%AC-v%C3%A0-n%C3%B3-ho%E1%BA%A1t-%C4%91%E1%BB%99ng-nh%C6%B0-th%E1%BA%BF-n%C3%A0o-trong-linux/

1. Git clone & change directory
2. Execute the following command

$ sudo apt install make
$ make install

3. Require the Package

After creating your new Laravel application you can include the Voyager package with the following command:

composer require tcg/voyager

4. Add the .env

Next make sure to create a new database and add your database credentials to your .env file:

APP_ENV=local
APP_DEBUG=true
APP_URL=http://localhost
APP_BUILD_TARGET=development

LOG_CHANNEL=stderr

LOG_STDERR_FORMATTER=Monolog\Formatter\JsonFormatter

DB_CONNECTION=mysql
DB_HOST=db
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=phper
DB_PASSWORD=secret

WEB_PUBLISHED_PORT=80
DB_PUBLISHED_PORT=3306
MAILHOG_PUBLISHED_PORT=8025

You will also want to update your website URL inside of the APP_URL variable inside the .env file:

APP_URL=http://localhost:8000

5. 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.

To install Voyager without dummy simply run

php artisan voyager:install

If you prefer installing it with dummy run

php artisan voyager:install --with-dummy

And we're all good to go!

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

6. 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:

email: admin@admin.com
password: password

NOTE: Please note that a dummy user is only created if there are no current users in your database.

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:

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:

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

And you will be prompted for the user's name and password.