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
archived
这是什么?Voyager 是 Laravel 应用的后台管理面板——一套 BREAD 系统(浏览、读取、编辑、添加、删除),让你直接在浏览器里管理网站数据,而不用从零搭建后台。它支持 Laravel 8 及更高版本。
它是独立应用,还是要装到我自己的 Laravel 项目里的东西?它是一个通过 Composer 安装到 Laravel 应用中的包——安装后会在你现有的项目里添加一个后台管理面板,而不是作为独立应用运行。
我怎么把它跑起来?先创建一个 Laravel 应用,用 Composer 安装 Voyager,把数据库信息和 APP_URL 填进 .env 文件,运行安装程序(可选择带或不带演示数据),然后用 php artisan serve 启动开发服务器。
它支持哪些 Laravel 版本?支持 Laravel 8 及更高版本。如果是 Laravel 6 或 7,应该用旧版的 Voyager 1.5;在 Laravel 10 上目前需要用开发版,正式版还在等发布。
它还在维护吗?不在了——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 及其配套的启动套件。
Creator
thedevdojo
Size
47.2 MB
Stars
11.8K
Age
9y
Commits · 90 Days