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)

Searching Database…

11.8K ·GitHub
Voyager
archived
Что это такое?Voyager — это админ-панель для приложений Laravel, то есть BREAD-система (Browse, Read, Edit, Add, Delete — просмотр, чтение, редактирование, добавление и удаление), которая позволяет управлять данными сайта прямо из браузера, не разрабатывая админку с нуля. Поддерживаются Laravel 8 и новее.
Это отдельное приложение или то, что я добавляю в свой проект на Laravel?Это пакет, который вы подключаете внутри приложения Laravel через Composer — после установки он добавляет админ-панель в ваш существующий проект, а не работает как отдельное приложение.
Как его запустить?Создайте приложение Laravel, подключите Voyager через Composer, укажите данные для подключения к базе и APP_URL в файле .env, запустите установщик (с демо-данными или без них), а затем поднимите дев-сервер командой php artisan serve.
Какие версии Laravel он поддерживает?Поддерживаются Laravel 8 и новее. Для Laravel 6 или 7 нужно использовать более старую версию Voyager 1.5, а на Laravel 10 сейчас требуется dev-релиз, пока постоянный ещё не вышел.
Проект ещё развивается?Нет — Voyager переведён в архив и больше не будет получать обновлений. Пользоваться им можно и дальше, но команда рекомендует переходить на более новые альтернативы, например FilamentPHP или Laravel Nova.
А что такое BREAD?Browse, Read, Edit, Add и Delete — просмотр, чтение, редактирование, добавление и удаление. Это пять операций, которые Voyager даёт вам для каждой таблицы базы данных через админ-панель, так что контентом можно управлять без написания CRUD-контроллеров вручную.
Что я получу, если установлю его с демо-данными?Одну учётку администратора ([email protected] / password), одну демо-страницу, четыре демо-поста, две категории и семь настроек. Учётная запись администратора создаётся только если в вашей базе ещё нет пользователей.
Как сделать существующего пользователя администратором?Есть artisan-команда, которая выдаёт права администратора существующему пользователю, а с флагом --create она вместо этого спросит у вас имя и пароль нового админа.
Что авторы предлагают использовать вместо него?Wave SaaS Starter Kit, FilamentPHP и Genesis Starter Kit — либо собственную админ-панель Laravel Nova и её starter kit'ы.
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