README

关于

这是新WordPress项目的模板。

由Qobo开发，用于Qobrix。

安装

有两种方式可以安装并开始使用此项目模板。

Composer

您可以使用Composer从这个模板创建一个新的项目。

composer create-project qobo/project-template-wordpress example.com
cd example.com
./bin/build app:install DB_NAME="app",PROJECT_NAME="My Project",PROJECT_VERSION="v1.0.0"

Git

或者，如果您想能够将项目更新到模板的最新版本，您可以使用git安装模板。

mkdir example.com
cd example.com
git init
# Pull the latest version from https://github.com/QoboLtd/project-template-wordpress/releases
git pull git@github.com:QoboLtd/project-template-wordpress.git vX.Y.Z
composer update
./bin/build app:install DB_NAME="app",PROJECT_NAME="My Project",PROJECT_VERSION="v1.0.0"
# Add your own remote repository
git remote add origin git@github.com/USER/REPO
# Push
git push origin master

使用上述方法，您将拥有模板开发的全历史记录。现在您可以开始自己的开发，并在未来的任何时刻升级到最新模板。

更新

如果您使用git安装了项目模板，您可以使用以下方法轻松地将应用程序升级到最新模板

cd exmample.com
# Make sure you are on the master branch and have a clean and up-to-date workspace
git checkout master
git pull origin master
# Create a new branch
git checkout -b project-template-update
# Pull the latest version from https://github.com/QoboLtd/project-template-wordpress/releases
git pull git@github.com:QoboLtd/project-template-wordpress.git vX.Y.Z
composer update
./bin/build app:update
# Check for conflicts, resolve if any, commit, and then push
git push origin project-template-update
# Create a pull request, review, and merge

用法

现在您已安装了项目模板，在开始修改之前，请检查它是否正常工作。启动PHP网络服务器

./bin/phpserv

或者在替代端口上运行它

./bin/phpserv -S localhost:9000

在浏览器中导航到http://localhost:8000。您应该看到标准的phpinfo()页面。如果是这样，所有部分都已就绪。

现在您可以像平常一样开发PHP项目，但具有以下优势

• 支持PHP内置网络服务器
• 使用.env文件按环境配置，该文件被git忽略
• 集成强大的构建系统（Robo）
• 将Composer与添加到.gitignore的vendor/文件夹集成
• PHPUnit与tests/文件夹和示例单元测试集成
• 最佳实践的合理默认值 - favicon.ico、robots.txt、MySQL转储、Nginx配置、GPL等。

例如，您可以通过修改包含在build/文件夹中的Robo文件，轻松自动化应用程序的构建过程。运行以下命令以检查可用的目标

./bin/build

如您所见，已经为应用程序的构建过程预留了一些占位符。默认情况下，建议您有以下这些

• app:install - 用于应用程序的安装过程
• app:update - 用于已安装应用程序的更新过程
• app:remove - 用于应用程序移除过程和清理

当然，您可以添加自己的，移除这些，或者以任何您想要的方式更改它们。有关如何使用这些目标和传递运行时配置参数的更多信息，请参阅Robo文档。

测试

PHPUnit和PHP CodeSniffer

运行PHPUnit和PHP CodeSniffer最快、最简单的方法是使用composer脚本

./bin/composer test

或者，您可以使用代码覆盖率报告运行测试

HTML格式的代码覆盖率报告将放置在./build/test-coverage/文件夹中。

Travis CI

持续集成是一种工具，它可以帮助您在代码库（提交、合并等）进行任何更改时运行测试。您可以使用许多工具，但project-template-wordpress提供了一个与Travis CI的示例集成。

查看.travis.yml文件，该文件描述了环境矩阵、项目安装步骤以及运行测试套件的方式。对于基于project-template-wordpress的实际项目，您可能希望从文件中删除示例测试。

示例

project-template-wordpress提供了一些如何编写和组织单元测试的示例。查看tests/文件夹。现在您没有任何借口不测试您的应用程序了！

配置

插件 - Compress PNG for WP（使用TinyPNG API）

此插件需要TinyPNG的API密钥。您可以使用参数TINYPNG_API_KEY在.env.example文件中设置您的密钥。模板中已添加默认有效API密钥，但由于每个密钥允许请求的数量有限，每个项目都应该使用自己的密钥。您可以在https://tinypng.com/developers（每个电子邮件地址一个密钥）处获取API密钥。