voyager README

The project's README from github.com/thedevdojo/voyager. As one markdown file: README.md.

[!Warning] We have decided to archive Voyager as there are many more modern options available. You may still use Voyager, but it will not be receiving any more updates. Here are some alternatives that we recommend:

Of course, you may also wish to reach for Laravels admin panel Nova, or you may want to reach for one of their many Starter Kits.

Thanks for all the wonderful times 🕺

Voyager is built with Vue and Bootstrap. If you are looking for a Laravel Starter Kit built that uses Livewire and Tailwind, you may be interested in checking out Genesis

Total Downloads Latest Stable Version License Awesome Voyager

Voyager - The Missing Laravel Admin

Made with ❤️ by The Control Group

Voyager Screenshot

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

Video Tutorial Here: https://voyager.devdojo.com/academy/

Join our Slack chat: https://voyager-slack-invitation.herokuapp.com/

View the Voyager Cheat Sheet: https://voyager-cheatsheet.ulties.com/

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

Want to use Laravel 6 or 7? Use Voyager 1.5

Installation Steps

1. Require the Package

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

composer require tcg/voyager

If you are installing this on Laravel 10, we are working on getting a permanent release available; however, you can still use this with Larvel 10 by requiring the following:

composer require tcg/voyager dev-1.6-l10

2. Add the DB Credentials & APP_URL

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

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:

APP_URL=http://localhost:8000

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.

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.

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: [email protected]
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 [email protected]

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 [email protected] --create

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

Sponsors

Voyager is proudly supported by our amazing sponsors. A big thank you to:

DigitalOcean Referral Badge

voyager (thedevdojo/voyager)

bootstrap
Searching Database…

11.8K ·GitHub
Voyager
archived
What is this?Voyager is an admin panel for Laravel apps — a BREAD system (Browse, Read, Edit, Add, Delete) for managing your site's data from a browser instead of building an admin from scratch. It supports Laravel 8 and newer.
Is this a standalone app, or something I add to my own Laravel project?It's a package you require inside a Laravel application via Composer — after installation it adds an admin dashboard to your existing project rather than running as a separate app.
How do I get it running?Create a Laravel app, require Voyager via Composer, add your database credentials and APP_URL to the .env file, run the installer (with or without dummy data), then start a dev server with php artisan serve.
Which Laravel versions does it support?Laravel 8 and newer are supported. For Laravel 6 or 7 you should use the older Voyager 1.5, and on Laravel 10 you currently need a dev release while a permanent one is still pending.
Is it still maintained?No — Voyager has been archived and will not receive any more updates. You can keep using it, but the team recommends moving to newer alternatives like FilamentPHP or Laravel Nova.
What does BREAD actually mean?Browse, Read, Edit, Add and Delete — the five operations Voyager gives you for every database table through the admin UI, so you manage content without writing CRUD controllers yourself.
What do I get if I install it with the dummy data?One admin account ([email protected] / password), one demo page, four demo posts, two categories and seven settings. The admin user is only created if your database has no existing users.
How do I make an existing user an admin?There's an artisan command that assigns admin privileges to an existing user, and with the --create flag it instead prompts you for a new admin's name and password.
What do the maintainers suggest using instead?Wave SaaS Starter Kit, FilamentPHP and the Genesis Starter Kit — or Laravel's own admin panel Nova and its starter kits.
What are similar projects?laravel-admin, filament, sage, laravel, livewire, bootstrap-vue, webserver, bootstrap-table
Which topics is it in?composer, crud, admin-panel, bootstrap, laravel, php, vue, deprecated, dashboard, backend, ui, web-development
Creator
thedevdojo
Size
47.2 MB
Stars
11.8K
Updated
CommitFeb 07Releasev1.8.0Sep 24
Age
9y
Commits · 90 Days