wireframe-framework/site-wireframe-boilerplate

基于wireframe输出框架的ProcessWire起始站点配置文件。

维护者

详细信息

github.com/wireframe-framework/site-wireframe-boilerplate

主页

源代码

问题

安装: 2

依赖项: 0

建议者: 0

安全性: 0

星标: 4

关注者: 2

分支: 1

开放问题: 0

语言:CSS

类型:pw-site-profile

0.11.3 2019-08-02 14:08 UTC

Requires

MPL-2.0 b88184e7ffb27fa88e6ff2c897c996f82a8d1811

processwiresite-profile

This package is auto-updated.

Last update: 2024-09-08 05:28:54 UTC

README

基于wireframe输出框架的ProcessWire起始站点配置文件。

本项目旨在为wireframe模块驱动的站点提供一个有见解的起点，并包含了一些作为站点配置文件的一部分更有意义的站点功能，而不是wireframe模块本身。

Git忽略（.gitignore）文件

请注意，wireframe boilerplate 包含了一个基于Bare Minimum Git（https://gist.github.com/salcode/10017553）的有见解的.gitignore文件。请确保此文件符合您的工怍流程，并根据需要修改它。

目的

默认.gitignore文件有两个主要用途：它将杂乱无章的内容排除在您的版本控制系统之外，更重要的是，它有助于避免将秘密泄露到VCS中。将敏感数据（密码、密钥等）存储在VCS中被视为不良做法，应予以避免。

重要注意事项

有关.gitignore文件的重要注意事项

  • ProcessWire模块目录默认被忽略。Wireframe boilerplate 预期模块文件将通过Composer捆绑，但您也可以手动添加特定的模块文件夹，或在.gitignore中取消此规则的注释。
  • ProcessWire资产目录被忽略。
  • ProcessWire开发配置文件（config-dev.php）和常用PHP环境变量文件env.php都被忽略。
  • 以点（.）、哈希/井号字符（#）或波浪号（~）开头的文件被忽略。
  • 各种类型的临时文件、SQL数据库和转储文件以及打包文件被忽略。这包括任何具有.backup、.bak、.old、.tmp或.temp后缀的文件。
  • Composer、Node、Grunt和Bower默认安装目录被忽略。

不使用Composer安装模块

由于默认情况下.site/modules/目录包含在.gitignore文件中忽略规则中，因此如果您将其添加到目录中并输入git status，则不会显示添加到其中的文件。这是故意为之，因为wireframe boilerplate 预期模块将通过Composer安装。话虽如此，不使用Composer安装模块并将它们添加到您的版本控制系统中也很容易

  • 将模块文件下载或克隆到您的/site/modules/目录中。
  • 从您的站点目录中，运行git add -f modules/[module-folder]。
    • 请注意，-f标志非常重要 - 如果您省略它，Git不会允许您将内容添加到被忽略的文件夹中！
  • 使用git commit modules/[module-folder] 将新添加的文件提交到Git中。

另一种明显的方法是注释或删除影响模块目录的.gitignore文件中的行。如果您真的想将所有模块文件和目录添加到Git中，这是完全可以接受的。最后，您还可以手动将单个模块文件夹添加到.gitignore文件中的“白名单文件”部分。

白名单文件

在 .gitignore 文件的末尾，您会找到一个用于白名单文件的章节。如果您的网站需要从基本规则中做出一些独特的调整，那么一个简单（且安全）的方法就是在此处添加更多规则，而不是删除之前的忽略规则。

要求

  • ProcessWire 3.0.112 或更高版本
  • PHP 7.1 或更高版本
  • Composer

其他要求，例如 ProcessWire 模块，将通过 Composer 安装。

关于 composer.json 的说明

如果您想知道为什么我们通过 composer.json 文件将 ProcessWire 本身指定为我们要求之一，尽管实际上我们并不需要它（作为一个 Composer 要求），这是一个用来强制 Composer 在需要时先安装 ProcessWire 的技巧，前提是它们在同一个项目中同时需要。

注意：如果您想的话，可以随意删除 ProcessWire 的要求，这不会破坏任何东西。

如何安装

  1. 获取 ProcessWire 3.0.112 或更高版本的最新副本，并将其上传/解压缩到您的服务器上。

  2. 将此存储库的内容下载或克隆到您上传/解压缩 ProcessWire 的目录中的 /site-wireframe-boilerplate/。您将看到其他网站目录（包括 /site-default/）已经存在，但暂时可以安全忽略这些目录。

  3. 转到 /site-wireframe-boilerplate/ 目录，并运行 composer install。

  4. 通过访问 Web 浏览器中它的 URL 来安装 ProcessWire。当安装程序要求您选择一个网站配置文件时，请选择 "Wireframe Boilerplate 网站配置文件"。

许可证

本项目采用 Mozilla 公共许可证版本 2.0 许可。