README

关于

QuidPHP/Project 仓库包含使用 QuidPHP 和 LemurCMS 创建新项目所需的必要结构。

许可证

QuidPHP/Project 在 MIT 许可证下作为开源软件提供。查看许可证.

文档

QuidPHP/Project 文档可在 QuidPHP/Docs 查看。

安装

QuidPHP/Project 可以通过 Composer 简单安装。它在 Packagist 上可用。

$ composer create-project quidphp/project --prefer-dist

要求

QuidPHP/Project 需要：

• 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) 数据库
• 任何现代浏览器（不包括 Internet Explorer）

依赖

QuidPHP/Assert 有以下依赖：

• quidphp/site - Quid\Site - 使用 QuidPHP 框架和 LemurCMS 构建网站的扩展平台

所有依赖项将通过 Composer 安装过程解决。

设置

安装完成后，只需遵循以下步骤：

1. 确保 storage 和 public 文件夹可由您的 Web 服务器写入。对于 storage，请确保所有子目录都可写。
2. 配置 Apache 虚拟主机或 Nginx 服务器块，以便将域名指向 public 文件夹的文档根。
3. 在新的 Mysql/MariaDB 数据库中导入 db.sql。
4. 复制 env-default.php 文件并重命名为 env.php。
5. 在 env.php 文件中更新方案主机。您需要为应用程序和 CMS 设置不同的主机（域名或子域名）。
6. 在 env.php 文件中更新数据库参数。
7. 不是必需的，但建议您更改 src 文件夹中所有 PHP 类的命名空间。默认命名空间为 Project。

通过 HTTP 启动

从您的网页浏览器中，输入到 public/index.php 入口文件的URL。使用的宿主将决定是否启动应用或CMS。

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 包含21个文件。以下为概览

• .gitignore - 项目标准 .gitignore 文件
• composer.json - 声明所有Composer PHP依赖的文件
• db.sql - 最小化所需数据库结构
• env-default.php - 声明应用环境数据，复制此文件并将其重命名为 env.php
• LICENSE - 存储库的MIT许可文件
• quid - 用于通过CLI启动应用和CMS的文件
• README.md - 以markdown格式编写的此说明文件
• storage/public/favicon.ico - 通用favicon（16x16），这将链接到 public/favicon.ico。
• css/app/_include.scss - 声明变量和混入的Scss样式表
• css/app/app.scss - 应用的主要Scss样式表
• js/app/app.js - 应用的主要JavaScript文件
• public/.htaccess - 简单的apache指令文件，需要mod_rewrite
• public/index.php - 通过HTTP请求启动应用和CMS的索引文件
• 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 - 用户表的行类

已知问题

• 在Windows上，创建符号链接存在一些问题。
• 在Windows上，您需要在数据库配置文件（my.cnf）中添加 lower_case_table_names = 2。表名和列名需要以自然的大小写形式存储。

测试

QuidPHP 测试套件可以通过创建一个新的 QuidPHP/Assert 项目来运行。