README

Drupal 项目启动包 (DPSK)

英文 • 法语

这是一个使用 composer create-project 命令开始 Drupal 项目的模板。

快速开始

本“快速开始”部分将向您展示如何设置一个可访问 http://example.local 的本地服务器，并准备好安装 Drupal。

前言

在您开始之前，应在您的 Mac 上安装开发依赖项。这些依赖项不是项目特定的，您可能已经安装了其中一些或全部。如果没有，找一个网络好的地方，并留出至少一个小时的时间来完成这一步骤。

开发依赖项包括

• Docker 或 Docker Desktop
• WSL2（在 Windows 10+ 上）
• DDev Local

一旦您安装了依赖项，设置此骨架将至少再花费一个小时，具体取决于您的互联网连接。

以下一些命令将提示您进行响应，默认答案在括号内。对于这个快速开始，按回车键接受每个默认答案

Enter a short name for your project [example] :

步骤

1. 创建一个名为 "example" 的新项目，基于此模板

composer create-project estoclet/dpsk example dev-develop --no-interaction

1. 进入您的新项目目录，并更新 .ddev/config.yml 中的 ddev 配置

# Update to match your project name. Using "dpsk" would make the site
# accessible at 'dpsk.ddev.site'.
name: dpsk

# Use 'docroot' for Acquia, or 'web' for Pantheon or Platform.sh.
docroot: web

1. 在 ddev 环境内部，运行来自 palantirnet/the-build 的脚本，以设置默认 Drupal 变量并安装 Drupal

ddev start
ddev ssh
vendor/bin/the-build-installer

1. 在您的网络浏览器中，访问 http://example.ddev.site
2. 可选： 当您登录到 ddev 环境时，您可以运行 Drush 命令，如 drush status。

加分项

• 根据 README.dist.md 的内容更新 README.md
• 在 composer.json 文件中更新项目名称，然后运行 composer update --lock
• 初始化一个 Git 仓库并提交您的作品
• 通过 https://example.ddev.site:8037 使用用户名 drupal 和密码 drupal 访问您的数据库
• 在 https://example.ddev.site:8026 查看您开发站点发送的电子邮件
• 在 https://example.ddev.site:8983 查看您的 Solr 服务器
• 使用 search_api_solr 模块在 Drupal 中连接到您的 Solr 服务器
  • HTTP 协议：http
  • Solr 服务器：solr
  • Solr 端口：8983
  • Solr 路径：/
  • Solr 核心库：dev
• 请注意，重命名或移动 example/ 项目目录可能会破坏您的 ddev 设置

完整项目设置

创建一个自定义名称的项目

使用 composer 创建一个基于此骨架的新项目，将 PROJECTNAME 替换为您的项目短名

composer create-project estoclet/dpsk PROJECTNAME dev-develop --no-interaction

更新您的文档

更新 README

• 删除 README.md
• 将 README.dist.md 重命名为 README.md
• 随意编辑

项目特定文档位于 docs/technical_approach.md

• 添加 deployment.md 以包含部署说明

更新 LICENSE.txt

• 删除或用适合您项目的适当许可证替换此文件。（现有许可证仅适用于 Drupal 模板。）

更新 composer.json

• 将 name 从 estoclet/dpsk 更改为 estoclet/PROJECTNAME
• 更新 description，包含您项目的简要描述。
• 根据您的工作许可方式更新 license 属性
• 更新锁文件，以便 composer 不会报错

  composer update --lock

配置您的 ddev 开发环境

进入您的新项目目录，并在 .ddev/config.yml 中更新 ddev 配置。

运行安装程序

在 ddev 内部运行 palantirnet/the-build 中的脚本，以设置基本的 Drupal 安装

ddev start
ddev ssh
vendor/bin/the-build-installer

将您的作品提交到 git

初始化 git 仓库并将您的作品提交到 develop 分支

git init
git checkout -b develop
git commit --allow-empty -m "Initial commit."
git add --all
git commit -m "Add the skeleton."

在 GitHub 上为您的工作创建一个空仓库。然后，将您的作品推送到仓库

git remote add origin git@github.com:estoclet/PROJECTNAME.git
git push -u origin develop

管理您的 ddev 环境

• 启动 ddev: ddev start
• 登录: ddev ssh
• 登出（就像您从任何其他 ssh 会话中登出一样）: exit
• 关闭 ddev: ddev stop
• 查找有关您的 ddev 环境的信息: ddev describe
• 另请参阅 ddev 文档

将 "the-build" 替换为 [其他内容]

如果您对 phing 过敏，而 Benadryl 没有帮助，您也可以删除 the-build

1. 运行 composer remove --dev palantirnet/the-build

2. 运行 rm -r .the-build

3. 运行 rm build.xml

4. 这将删除 drush、coder 和 phpmd -- 如果您需要这些依赖项，您需要将它们添加回您的项目

   composer require --dev drush/drush drupal/coder phpmd/phpmd
   

5. 审查您的 web/sites/default/settings.*.php 文件（the-build 已为您管理这些文件）

6. 安装您选择的构建工具... 或者什么都不安装...

7. 更新您项目的 README

另请参阅：使用 the-build 的文档

从命令行安装 Drupal

当使用 drush 或 phing 来管理您的 Drupal 网站时，您需要登录到 ddev 环境（ddev ssh）。

如果您已在 ddev 内运行了 vendor/bin/the-build-installer，则 Drupal 将被安装，初始配置将导出到 config/sites/default/。

您可以使用 palantirnet/the-build 提供的 phing 脚本来在任何时候从配置重新安装站点

vendor/bin/phing install

或者，您可以直接使用 drush

drush site-install --existing-config

以代码形式管理您的配置

在 Drupal 8 开发中，所有（或大部分）Drupal 配置都应导出并作为代码库的一部分处理。在此基础上，我们使用 config_installer 配置文件 来允许我们使用导出的配置作为可重复、自动化友好的构建和安装过程的依据。我们还使用 config_split 来管理特定环境的配置。

1. 在浏览器中登录到 Drupal 并进行一些基本的配置自定义

• 设置站点时区
• 禁用每个用户的时区
• 禁用用户账户创建
• 删除不必要的文件类型
• 设置管理员电子邮件地址（您的开发环境将捕获所有电子邮件）
• 将Cron间隔设置为“从不”
• 卸载不必要的模块（例如搜索、历史记录、评论）

1. 导出您的配置

drush cex -y

1. 您应该在 config/sites/default/ 中有许多新的 *.yml 文件。将它们和此配置更改添加到git

git add config/
git ci -m "Initial Drupal configuration."
git push

1. 重新安装您的网站并验证您的配置是否已准备就绪

vendor/bin/phing install

更多信息

• 网站构建和安装过程：palantirnet/the-build

版权所有 2016 - 2022 Eric Stoclet。