anticopyright-code / module-core
一个Laravel扩展包,使用VueJS和Element-UI构建美观的数据仪表板
Requires
- php: ^8.1.1
- tymon/jwt-auth: ^1.0
This package is auto-updated.
Last update: 2024-09-18 16:09:11 UTC
README
提供核心功能的Laravel仪表板扩展包 Laravel dashboard
入门
Laravue 提供了必要的企业管理仪表板Element UI和丰富功能,因此强烈推荐用于项目启动。以下说明是关于将Laravue的核心功能集成到现有的Laravel项目或进行实验。
先决条件
Laravue 建立在 Laravel 之上,因此您必须检查 Laravel的系统要求,并在开始之前确保您的 NodeJS 已准备好。
安装
使用 composer
安装 laravue-core 包
composer require tuandm/laravue-core
1.a 使用一键命令设置Laravue
php artisan laravue:setup
此命令将执行以下步骤
- 设置JWT密钥和API端点
- 发布Laravue供应商包/资产
- 安装NPM依赖项
- 创建 .babelc 文件(如果尚不存在)
- 设置 webpack.mix.js(请备份此文件以确保当前设置不会丢失)
1.b 手动设置
建议使用 laravue:setup 命令。如果您想手动安装,可以执行以下步骤
.env 文件
生成用于身份验证的JWT密钥
php artisan jwt:secret
将以下两行添加到 .env
文件中
BASE_API=/api
MIX_BASE_API="${BASE_API}"
发布供应商包/资产
php artisan vendor:publish --provider="Tuandm\Laravue\ServiceProvider" --tag="laravue-core"
php artisan vendor:publish --provider="Tuandm\Laravue\ServiceProvider" --tag="laravue-asset"
添加NPM依赖项
npm add babel-plugin-syntax-dynamic-import babel-plugin-syntax-jsx babel-plugin-transform-vue-jsx eslint eslint-loader eslint-plugin-vue laravel-mix-eslint vue-template-compiler svg-sprite-loader --save-dev
npm add element-ui js-cookie normalize.css nprogress vuex vue-count-to vue-i18n vue-router
npm install # To make sure everything is set
请参阅 package.json样本
Webpack.mix.js 配置
我们需要修改 webpack.mix.js 以与Laravue包一起使用,请参阅 webpack.mix.js样本
或者简单地运行此命令以生成推荐版本。
php artisan laravue:webpack
Babel
Laravue需要babel来构建包。通常,.babelrc
将由 laravue:setup 命令 生成。如果您的项目已经使用它,请手动将所需插件添加到 .babelrc
文件中。示例 .babelrc
可以在此处找到 here
2. 配置API守卫
打开 config/auth.php
并进行如下修改
# Change default auth guard to api
'defaults' => [
'guard' => 'api',
],
...
# Use JWT driver for api guard
'guards' => [
....
'api' => [
'driver' => 'jwt',
....
# Use Laravue User model to authenticate
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => Tuandm\Laravue\User::class,
],
请参阅 auth.php样本
3. 数据库
Laravue核心需要 users.role
字段,如有必要,请运行迁移
php artisan migrate
4. 示例数据
此数据库种子将插入3个测试用户,如果您已有数据,则可以忽略此步骤。
php artisan db:seed --class=Tuandm\\Laravue\\Database\\Seeds\\DatabaseSeeder
开始开发
npm run dev # or npm run watch
构建生产版本
npm run production
运行测试
- 测试系统正在开发中。
构建于
- Laravel - PHP框架,面向Web艺术家的框架
- VueJS - 进步的JavaScript框架
- Element - 为开发者、设计师和产品经理提供的基于 Vue 2.0 的组件库
- Vue Admin Template - 基于 Element UI 的最小化 Vue 管理模板
贡献
请阅读 CONTRIBUTING.md 了解我们的行为准则和向我们的提交拉取请求的过程。
版本控制
我们使用 SemVer 进行版本控制。有关可用的版本,请查看此存储库的 标签。
作者
- 杜湮 - 初始工作 - tuandm
请参阅参与此项目的 贡献者列表。
许可证
本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE.md 文件。
致谢
- Laravue - 由 VueJS 和 ElementUI 构建的 Laravel 仪表板
- vue-element-admin - 受到 Laravue 项目启发的神奇 Vue 管理界面
- tui.editor - Markdown WYSIWYG 编辑器
- Echarts - 用于浏览器的强大、交互式的图表和可视化库