asha23 / arlo-base-wordpress
A Composer 框架,帮助您在一分钟内快速搭建 WordPress 环境
Requires
- php: >=7.1
- asha23/wp-seed: *
- composer/installers: ~1.0.12
- johnpbloch/wordpress: *
- oscarotero/env: ^1.0
- vlucas/phpdotenv: ^2.0.1
- wp-sync-db/wp-sync-db: *
- wpackagist-plugin/acf-content-analysis-for-yoast-seo: *
- wpackagist-plugin/classic-editor: *
- wpackagist-plugin/duplicate-post: *
- wpackagist-plugin/simple-image-sizes: *
- wpackagist-plugin/tinymce-advanced: *
- wpackagist-plugin/wordpress-seo: *
- wpackagist-plugin/wps-hide-login: *
README
一个 WordPress/Composer 框架。
composer create-project asha23/arlo-base-wordpress your-folder-name
这假设您已了解如何设置 WordPress 主题。欢迎对它进行改进。
它非常(非常)松散地基于 Bedrock,但对于区分开发/预发布/生产数据库的方法更为简化。我发现对于我的大部分工作实践,我并不需要 Bedrock 提供的很多功能,因此决定将其方法论作为起点,但保持它非常简单。
如果您喜欢 Bedrock,那就太好了!它非常棒,所以尽情使用吧。但如果您发现它有点过于复杂,像我一样有点臃肿,那么这个框架/方法可能更适合您。
您可以在大约一分钟内搭建一个完整的 WordPress 环境。
基本安装说明
- 为您的项目创建一个新的仓库
- 下载此 zip 文件并将其解压到仓库中 - https://bitbucket.org/this-is-pegasus-team/pegasus-wordpress-composer/get/master.zip
- 打开终端并浏览到您正在使用的文件夹
- 安装 Composer - https://getcomposer.org.cn/
- 安装 Node - https://node.org.cn/en/
- 安装 Bower - https://bower.io/
- 安装 Yarn - https://yarn.npmjs.net.cn/
- 将 .env-example 重命名为 .env 并填写相关字段。
- 安装 Composer 后,需要运行
$ composer install
。这将安装所有基础插件和种子主题到正确的目录。 - 将初始提交发送到您的仓库
- 开始。
composer create-project asha23/arlo-base-wordpress your-folder-name
要求
您应该为该框架获取 Advanced Custom Fields pro 的许可证。
开始使用
文件夹中有一个 Vagrant 文件,它使用 Scotchbox 版本的 Vagrant
从根目录运行 vagrant up
(目前尚未测试)- 然后,您的网站将可在
192.168.33.10
以下信息用于连接到数据库
MySQL 主机:127.0.0.1
用户名:root
密码:root
SSH 主机:192.168.33.10
SSH 用户:vagrant
SSH 密码:vagrant
或者,只需使用 MAMP。或者像 https://www.themejuice.it 这样的东西,它为本地使用 WordPress 进行开发提供了一个优秀且用户友好的环境。或者您喜欢的任何其他本地部署方法。
Vagrant 是推荐的方法,因为它可以将所有内容保持自包含。
.env-example 文件
根目录中有一个 .env-example 文件。您应该填写此文件中的相关信息,然后将其重新保存为 .env。完成此操作后,您可以编辑 web/wp-config.php 文件并添加盐值,或进行其他配置。
这里包含有关 3 个环境的信息,开发、生产和预发布。正确填写这些信息将使网站更容易部署,因为它将根据您的环境自动检测要使用哪个数据库。
.gitignore 的注意事项。
默认情况下,此安装会忽略除主题之外的所有内容。您需要在生产环境中创建一个WordPress部署并运行composer install。
如果您无法这样做,只需按需上传文件。我决定不在仓库中包含所有WordPress内容,因为实际上这只是一个不必要的步骤。
不过,如果您想改变这一点,请随意编辑.gitignore文件。
关于种子主题的说明
此主题使用Gulp进行编译,并使用Bower进行JavaScript依赖管理。它还基于SASS Bootstrap 3。
主文件夹结构如下
web/content
web/wp
内容文件夹包含所有主题、插件和前端文件。
wp文件夹是基本的WordPress安装 - 您不应在此处更改任何内容。
主题设置
首先,导航到主题文件夹。web/content/themes/wp-seed
。您应该将其重命名为反映项目名称,并更改styles.css中的信息
在开始之前,您需要在计算机上安装node.js、npm和Yarn
https://node.org.cn/en/
https://yarn.npmjs.net.cn/
如果您尚未在计算机上安装,请全局安装Gulp。
$ yarn add gulp -g
如果尚未安装,请安装Bower
$ yarn add -g bower
步骤详解
种子主题使用Gulp和Yarn进行依赖管理。Yarn是由Facebook创建的依赖管理器,它似乎比使用npm快得多。它将收集所有npm依赖项并使用它们,因此非常相似
在终端中,cd到您的主题目录并执行
$ bower install
$ yarn
这将为您设置好一切,以便您可以使用主题开始开发。
Gulp命令
$ gulp watch
$ gulp images
$ gulp
gulp watch
将启动监视任务,并
gulp images
将在图片文件夹上运行图像优化(在部署前很有用) - 独立运行以执行任务一次。
gulp
单独运行以执行任务一次。
wp-seed 文件夹结构
在主题内部,您将找到以下结构。这假设您对WordPress主题技术有些了解。这基本上是一个裸骨合理的结构。
/acf-json
这是用于高级自定义字段。您会在这里找到一些用于处理全局网站选项的字段设置。按需使用。您应该确保已安装Advanced Custom Fields Pro。
/build
这是部署的构建文件夹。您会在这里找到图片和字体文件夹。您不应在此文件夹中保存其他任何内容,因为Gulp将为您编译所有内容。
/includes
这是所有核心主题php文件。这些文件包含在网站根目录的functions.php文件中。一般来说,您不需要在此处编辑任何内容,除了custom-post-types.php和menus.php - 有一个helper-functions.php文件,您可以在其中添加任何有用的代码片段。
/library
您可以在其中编辑styles.scss
文件和scripts.js
- 这也是添加所有Bower组件的地方。
/views
如果您正确使用WordPress模板部分(或者如果您更喜欢,则使用标准的php includes),您可以在此视图中将网站内容分离。
/bower
只要您运行bower install
,它就会自动添加。
关于Gulpfile.js的说明
此文件包含连接Bower依赖项的所有路径结构,创建链接以添加到编译过程中所需的任何新Bower组件和依赖项相对简单。
我们将脚本拉入js/vendor-libs
文件夹,然后在构建文件夹中将它们编译为scripts.min.js
。如果您愿意,可以直接引用/bower
文件夹中的文件路径,并跳过此步骤。
一般来说,这些路径是您在这个文件中需要修改的唯一内容,但如果您知道如何更好地完成这里的一些任务,那么请随意调整以适应您的工作方式 - 这个Gulpfile还在不断完善中。
Bower依赖管理使用说明
尽可能使用Bower来添加任何JavaScript或CSS模块到这个主题中。许多常用的库和框架现在是Bower生态系统中的一部分。这将确保您的所有依赖项都保持完整,并且您始终使用库的最新版本。
如果您有一段时间没有访问过项目,定期运行bower update
是值得的。
一般注意事项
目录/node_modules
、/bower
、wp-config
以及许多其他文件都被忽略。您不应该将这些文件夹包含在部署中,因为这会导致不必要的膨胀。从代码库拉取到预发布或生产环境,而不是通过FTP上传文件,这是更好的选择。