oddhill / drupal-starter-kit
创建基于Drupal 9的新网站时使用的启动套件。
Requires
- composer/installers: ^1.0
- drupal/core-composer-scaffold: ^9.0
- drupal/core-project-message: ^9.0
- drupal/core-recommended: ^9.0
- oddhill/oddprofile: ^2.0
- vlucas/phpdotenv: ^5.0
Requires (Dev)
- cweagans/composer-patches: ^1.7
- drupal/coder: ^8.3
- drush/drush: ^10.0
Conflicts
This package is auto-updated.
Last update: 2024-09-03 14:58:22 UTC
README
这是一个用于使用基于composer的工作流程创建Drupal新站的启动套件。Odd Hill在创建新项目时使用此项目。
显著特性
- 使用vlucas/phpdotenv加载本地环境配置。
- 使用推荐的Drupal composer包来构建项目。
- 通过CircleCI和SSH轻松部署。
要求
要求基本上与Drupal 9相同,但会略高一些,以便我们能够利用新的语言功能等。如果你需要使用较低版本,只要遵循Drupal 系统要求,一切应该都能正常工作。如果你决定使用其他版本,可能需要修改CircleCI配置。
- Composer 2.0
- PHP 8.1
- Apache
- MySQL 5.7或8.0
入门
创建
首先确保你已满足使用启动套件的所有要求。然后,你可以运行以下命令来创建一个基于此仓库的新项目
composer create-project oddhill/drupal-starter-kit ./project-dir --stability dev --no-interaction
准备
- 将位于examples文件夹中的settings.php复制到
public/sites/default
目录。 - 将位于项目根目录下的
.env.default
文件复制并重命名为.env
。 - 更新
.env
文件中的环境变量,以匹配本地环境的设置。
安装
在第一次加载网站时,你会遇到错误,因为Drupal尚未安装且数据库为空。
要安装Drupal,你必须在浏览器中打开example.localhost/core/install.php
页面,然后完成安装过程。
你现在已安装并配置了一个新的Drupal站点,使用环境变量、我们的自定义配置文件、基本部署等。
添加主题
你可以使用任何与这个启动套件兼容的主题,但建议使用我们的启动主题oddbady,因为它与CircleCI配置集成良好。
部署
部署通过CircleCI处理。部署脚本只支持Linux环境,因为使用了rsync和SSH进行部署。部署还会运行各种步骤,检查自定义模块和主题的编码标准,并为部署构建主题。
处理代码检查和主题构建的步骤假设使用了我们的启动主题oddbady。
由于你很可能会将主题重命名以适应特定项目,部署配置顶部有一个参数可以轻松更改,这将允许你设置应使用的主题目录。
首次部署
首次部署会有所不同,因为网站尚未在服务器上设置。由于这个原因,部署后的步骤总是会失败,可以在第一次部署运行之前暂时禁用,然后在网站设置完成后再次启用。
由于部署是通过CircleCI完成的,因此在进行第一次部署之前需要更新配置文件。请确保已设置正确的主题路径,并且已更改部署和部署后步骤的配置以匹配应部署到该站点的服务器。
您还需要在CircleCI中设置项目,并将SSH密钥添加到项目中,以便服务器允许SSH连接。如果您之前没有这样做过,请阅读如何向CirclecI添加SSH密钥。
首次部署网站后,您必须执行以下步骤以使网站上线。
- 复制
.env.default
文件,将其重命名为.env
,然后编辑它并设置正确的环境变量。 - 在
public
文件夹中创建一个.htaccess
文件,并将您本地复制的.htaccess
文件的内容粘贴进去。这是必需的,因为该文件在部署步骤中会被rsync忽略。 - 创建
public/sites/default/files
目录,并确保该文件夹的权限设置为775。 - 通过访问
example.domain/core/install.php
来访问网站,现在您应该能看到安装页面。完成这些操作后,网站就准备就绪了!