README

Sous 项目

这是您的 Drupal 项目的入门套件，通过 Emulsify 简化项目设置。此入门套件包括一组小的贡献模块、一组基本的配置和一个由 EmulsifyCLI 生成的入门主题。

功能和配置

Sous 不仅基于 Emulsify 生成自定义主题，还基于 Drupal 的默认配置来帮助简化项目设置流程。请参阅功能集文档 此处。

安装

要求

没有这些，您将难以安装此项目。

1. PHP ^8.1
2. Composer 2.x
3. Lando ^3.6

使用以下命令，并用您选择的项目名称替换 PROJECT_NAME。

composer create-project fourkitchens/sous-drupal-project [PROJECT-NAME]

您将被提示选择要安装的 Sous 版本。主要版本包括：

1. Sous 带布局构建器
2. Sous 带段落

这两个版本都包括 Emulsify 作为默认主题，以及 Gin 管理员和我们的推荐安全、性能和管理模块。

重要最后一步：解包

配方依赖项需要解包到根 composer.json 文件。此功能目前正在 Drupal 核心中开发。在此期间，您将需要为 web/recipes 中的每个配方运行此命令。

php /usr/local/bin/composer unpack "$recipe_full_package_name

例如：php /usr/local/bin/composer unpack fourkitchens/sous-layout-builder

这将把所有依赖项移动到根目录，并从 web/recipes 中删除该配方。

与 Emulsify 合作

此项目安装了 Emulsify 主题。

额外工具

此包提供了一些额外的工具来支持构建。

辅助脚本

要使用提供的辅助脚本，您需要安装 npm。然后只需运行 npm run <command>。例如：npm run import-data。这些命令位于 ./scripts/sous 目录中的 bash 脚本，并在 package.json 中定义。

配置管理脚本

confex

npm run confex

将活动配置导出到配置目录。

confim

npm run confim

将配置导入到数据库。

import-data

npm run import-data

将规范数据库备份的副本导入到您的本地实例。这假设数据库备份位于 ./reference/db.sql.gz。

local-data-bak

npm run local-data-bak

创建本地数据库备份。将备份保存到 ./reference 目录。

rebuild

npm run rebuild

重建您站点的全新本地实例。导入规范数据库备份并将配置导入其中。

setup

npm run setup

这是在 composer create project 安装过程中运行的。

theme-build

npm run theme-build

构建基于 Emulsify 的主题。

theme-watch

npm run theme-watch

用于主题开发。

语义版本化

设置

1. 此存储库有以下命名/维护分支：

main
x.x
x.x.x

1. 这些分支在 GitHub 上受到保护
2. 为 CircleCI 创建了个人访问令牌。
3. CircleCI 已设置在此项目中运行并标记版本
4. 遵循 常规提交指南 提交更改
5. 将更改推送到并验证 CircleCI 是否通过并已在此所需的分支上运行。

故障排除

1. 您的分支必须是一个命名的稳定版本分支，才能获取标签。
2. 由于该包包含点，因此不支持预发布版本。

贡献

可以调整composer命令，以适应您正在工作的新分支。

composer create-project fourkitchens/sous-drupal-project:dev-[branch-name] PROJECT_NAME

无需创建项目即可贡献

运行设置 + 安装

1. 克隆仓库 gh repo clone fourkitchens/sous-drupal-project [目录]
2. cd 到您的项目目录
3. 在 .lando.yml 中更改您的项目名称
4. lando start
5. composer install
6. composer run-script post-create-project-cmd（需要本地安装composer。即在lando外部）

要安装菜谱，请使用 lando install-recipe 命令。例如，对于Sous的段落版本，运行

lando install-recipe fourkitchens/sous-paragraphs