evanwarner/craft-boilerplate

一个Craft CMS的模板构建。

维护者

详细信息

github.com/evanwarner/craft-boilerplate

源代码

问题

安装: 14

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 2

语言：CSS

类型：项目

v6.0.2 2023-08-01 01:17 UTC

Unlicense 03a43a0192719e2a6bff771b7f68422e0d7cb7f1

This package is auto-updated.

Last update: 2024-09-30 01:37:53 UTC

README

本项目作为一个模板，可以通过 composer create-project 命令生成新的Craft CMS项目。这是一个针对我喜欢的网站构建方式定制的配置。

该模板创建了一个Craft 4.x构建，并带有DDEV的本地开发配置。如果你更喜欢DDEV以外的本地开发环境，你可以自由地调整设置过程。

如何使用模板

要使用此包生成新的Craft CMS项目，请运行以下命令，其中 <path> 是你想要作为项目根的系统路径

composer create-project evanwarner/craft-boilerplate <path>

注意： 作为项目创建过程的一部分，此文件将被重命名为 SETUP.md，而文件 README-site.md 将变为 README.md，因为它旨在成为与生成的项目一起保留的README文件。

项目设置

以下步骤应在生成新项目后立即完成。完成后，可以删除此文件。

GIT

  1. cd 到项目根目录
  2. git init
  3. git commit --allow-empty -m "Initial commit"
  4. 添加所需的git远程（假设命名为 origin）
  5. git push -u origin master
  6. git checkout -b develop

结构

  1. 将 /webroot 重命名为适合此项目的名称（以匹配生产服务器）
    • 更新 /.ddev/config.yaml 中的 docroot 配置以匹配
    • 更新 package.json 中的 config.webroot 变量以匹配
    • 更新 /craft/config/general.php 中 * > aliases > @webroot 路径以匹配
    • 更新 .gitignore 中的路径以匹配
    • 更新 README.md 中 入门 部分的路径以匹配
  2. （可选） 你可以将 /craft 重命名为此项目的首选名称
    • 更新 /.ddev/config.yaml 中的 composer_root 配置以匹配
    • 更新 /.ddev/config.yaml 中的 web_environment > CRAFT_CMD_ROOT 配置以匹配
    • 更新 package.json 中的 config.craft 变量以匹配
    • 更新 /[webroot]/index.php 中共享引导的 require 路径以匹配
      • require dirname(__DIR__) . '/[craft]/bootstrap.php';
    • 更新 .gitignore 中的路径以匹配
    • 更新 README.md 中 入门 部分的路径以匹配
    • 更新 README.md 中 文件组织 部分的路径以匹配
    • 在继续执行以下步骤时，请注意此更改
  3. 确保这些目录的权限
    • chmod 774 /[craft]/storage
    • chmod 774 /[craft]/vendor
  4. 确保craft cli可执行文件的权限
    • chmod 755 /[craft]/craft

项目配置

  1. 编辑 README.md 中的 项目名称 和 项目描述
  2. 编辑 /.ddev/config.yaml 中的 name 配置
  3. 在 package.json 中设置 name 和 description
  4. 在 /[craft]/composer.json 中设置 name 和 description
  5. 在 /[craft]/.env 中设置 CRAFT_APP_ID
  6. 在 /[craft]/.env 中设置 SYSTEM_NAME
  7. 在 /[craft]/.env 中设置 SITE_NAME
  8. 配置项目域名
    • 在/.ddev/config.yaml中的additional_fqdns配置下编辑项目域名
    • 在/[craft]/.env中设置SITE_URL
    • 在/src/manifest.json中将start_url设置为生产域名
  9. 在/[craft]/.env中设置SYSTEM_EMAIL
  10. 在/[craft]/.env中设置SYSTEM_SENDER_NAME
  11. 在/[craft]/.env中设置SYSTEM_REPLY_TO_EMAIL
  12. 在/[craft]/.env中设置TEST_EMAIL
  13. 根据需要，在/src/.htaccess中注释或删除www和https重写设置

环境设置

  1. 从项目根目录运行npm run dev来编译源文件并监视更改

DDEV

  1. 根据需要调整/.ddev/config.yaml中的附加环境配置（版本、端口）
  2. 从项目根目录运行ddev start

Craft设置

  1. 在/[craft]/.env中创建CRAFT_SECURITY_KEY
    • 运行ddev craft setup/security-key（或手动生成一个）
  2. 在http://[local hostname]/manage运行Craft安装
    • 将主站点的名称设置为$SITE_NAME
    • 将主站点的URL设置为$SITE_URL
  3. 在设置 > 一般中适当地设置系统时区
  4. 在设置 > 站点中设置站点组的名称（根据需要）

GIT开发分支

  1. 删除此文件。
  2. git add -A
  3. git commit -m "添加并配置站点模板内容"
  4. git push -u origin develop