quidphp / vue
使用 QuidPHP、LemurCMS 和 Vue 创建新项目
5.31.0
2022-07-11 03:08 UTC
Requires
- php: >=8.1.0
- quidphp/site: 5.31.*
This package is auto-updated.
Last update: 2024-09-11 08:13:00 UTC
README
关于
QuidPHP/Vue 仓库包含创建使用 QuidPHP、LemurCMS 和 Vue 的新项目的必要结构。
许可证
QuidPHP/Vue 是在 MIT 许可证下作为开源软件提供的。MIT 许可证。
文档
QuidPHP/Vue 文档可在 QuidPHP/Docs 找到。
安装
QuidPHP/Vue 可以通过 Composer 简单安装。它可在 Packagist 上找到。
$ composer create-project quidphp/vue --prefer-dist
要求
QuidPHP/Vue 需要以下内容
- Apache 或 Nginx 服务器(在 MacOS 或 Linux 环境下运行)。
- 在 Windows 环境下也能工作,但存在一些 已知问题。
- PHP 8.1
- 以下扩展
- ctype
- curl
- date
- fileinfo
- gd
- iconv
- json
- mbstring
- pcre
- openssl
- session
- SimpleXML
- zip
- PDO
- pdo_mysql
- 以下 PHP INI 指令
- post_max_size 必须至少为 1MB
- post_max_size 必须大于 upload_max_filesize
- memory_limit 必须至少为 128MB
- 以下扩展
- Mysql (>= 8.0) 或 MariaDB (>= 10.4) 数据库
- NodeJs LTS 版本 (>= 16)
- 任何现代浏览器(不包括 Internet Explorer)
依赖项
QuidPHP/Assert 有以下依赖项
- quidphp/site - Quid\Site - 使用 QuidPHP 框架和 LemurCMS 构建网站的扩展平台
- quidphp/navigation - 用于在不重新加载页面的情况下导航网站的 JavaScript 模块
- vuejs/vue - Vue.js 是一个用于在 Web 上构建 UI 的渐进式、可增量采用 JavaScript 框架。
- vuejs/vuex - Vue.js 的集中式状态管理。
- laravel-mix/laravel-mix - 为其他人提炼的 webpack 的力量
- scottcharlesworth/laravel-mix-polyfill - Quid\Main - 一个用于使用 Babel、core-js 和 regenerator-runtime 包含 polyfills 的 Laravel Mix 扩展
- sass/dart-sass - Sass 的参考实现,用 Dart 编写。
- webpack-contrib/sass-loader - 编译 Sass 到 CSS
- shakacode/sass-resources-loader - SASS 资源(例如变量、混合等)加载器,用于 Webpack。
- vuejs/vue-loader - Vue.js 组件的 Webpack 加载器
所有依赖项将通过使用 Composer 安装过程来解决。
设置
安装完成后,只需遵循以下步骤
- 确保您的网络服务器可以写入 storage 和 public 文件夹。对于 storage,还要确保所有子目录都可写。
- 配置 Apache 虚拟主机或 Nginx 服务器块,以便将域名指向 public 文件夹的文档根。
- 在新的 MySQL/MariaDB 数据库中导入 db.sql 文件。
- 复制 env-default.php 文件,并将其重命名为 env.php。
- 更新 env.php 文件中的主机方案。您需要为应用程序和 CMS 设置不同的主机(域名或子域名)。
- 更新 env.php 文件中的数据库参数。
- 这不是必须的,但建议您更改 src 文件夹中所有 PHP 类的命名空间。默认命名空间是 Project。
通过 Webpack/HTTP 启动
在命令行中打开项目文件夹。要启动具有热模块重载(HMR)的开发服务器,请输入
npm run hot
您的应用程序将在 env.php 文件中定义的主机上可用。同时还将启动第二个 Node 服务器来处理 HMR 请求(默认为 localhost 的 8079 端口)。您可能需要接受该 localhost 的自签名证书。
Webpack 生产构建
要生成 Vue 应用程序的生产构建,请在命令行中打开项目文件夹并输入
npm run prod
QuidPHP CLI 路由
在命令行中打开项目文件夹。现在,您可以输入以下格式的命令
php quid [path][:envType] exemple: php quid /en/my-url php quid /en/my-url:dev/cms php quid /:prod/app
LemurCMS 凭据
一旦您在浏览器中打开 CMS,您将需要登录。默认用户是
- 用户名: admin
- 密码: changeme123
登录后,您将能够更改用户密码并创建新用户。
概览
QuidPHP/Project 包含 30 个文件。以下是概述
- .gitignore - 项目标准的 .gitignore 文件
- composer.json - 声明所有 Composer PHP 依赖项的文件
- db.sql - 所需的最小数据库结构
- env-default.php - 声明应用程序的环境数据,复制此文件并将其重命名为 env.php
- LICENSE - 存储库的 MIT 许可证文件
- package.json - 声明所有 NPM 依赖项的文件
- quid - 用于通过 CLI 启动应用程序和 CMS 的文件
- README.md - 以 markdown 格式编写的此说明文件
- webpack.mix.js - laravel-mix 的配置文件
- storage/public/favicon.ico - 通用 favicon(16x16),这将链接到 public/favicon.ico。
- public/.htaccess - 简单的Apache指令文件,需要mod_rewrite模块
- public/index.php - 应用程序和CMS的启动索引文件,通过HTTP请求启动
- src/Boot.php - 启动应用程序和CMS的类
- src/Route.php - 路由的抽象类,所有路由都将扩展此类
- src/Row.php - 行的抽象类,所有行都将扩展此类
- src/Session.php - 用于表示活动会话的类
- src/App/_template.php - 所有生成界面的路由使用的特性
- src/App/Error.php - 应用程序错误路由的类
- src/App/Home.php - 应用程序主页路由的类
- src/Row/User.php - 用户表行的类
- src/Service/Vue.php - 与vue和前端资源加载相关的类
- app/app.scss - 应用的主scss样式表,注入到组件中
- app/app.vue - 加载正确路由的根组件
- app/global.js - 声明一些全局变量的脚本
- app/index.js - Vue应用的入口文件
- app/store.js - 包含全局可用的Vuex获取器和突变
- app/component/HelloWorld.vue - 在h1标签中显示“Hello World”的组件
- app/interface/Layout.vue - 通用页面布局的组件
- app/route/Error.vue - 错误路由的组件
- app/route/Home.vue - 主页路由的组件
已知问题
- 在Windows上,创建符号链接时存在一些问题。
- 在Windows上,您需要在数据库配置文件(my.cnf)中添加 lower_case_table_names = 2。表和列名需要以自然的大小写存储。
测试
QuidPHP 测试套件可以通过创建一个新的 QuidPHP/Assert 项目来运行。