README

LocalGov Drupal 微站

Drupal 分发和安装配置文件，帮助英国地方议会协作并共享 Drupal 代码，以便从单个 Drupal 安装发布多个微站的内容。

此存储库是 Drupal 安装配置文件，最好使用 composer 安装项目模板，localgov_microsites_project，以构建包括此配置文件在内的代码库。

请参阅https://github.com/localgovdrupal/localgov_microsites_project

资金

这项工作最初由地方数字基金（https://www.localdigital.gov.uk/fund/）提供资金，该基金来自提升、住房和社区部（DLUCH）。

支持的分支

我们正在积极支持和发展 Drupal 10 的 4.x 分支。

1.x、2.x 和 3.x 分支不再积极支持，不推荐用于新网站。

如果您仍在网站上使用 1.x、2.x 或 3.x 分支，请在 Github 上创建一个问题，让我们知道。

文档

有关开发者、内容设计师和其他受众的更多文档可以在https://docs.localgovdrupal.org/microsites/找到。

安装

有关安装步骤，请参阅：https://github.com/localgovdrupal/localgov_microsites_project

在本地安装 LocalGov Drupal 的要求

要本地安装 LocalGov Drupal，您需要以下适当的版本

PHP（见https://www.drupal.org/docs/system-requirements/php-requirements）
数据库服务器，如 MySQL（见https://www.drupal.org/docs/system-requirements/database-server-requirements）
Web 服务器，如 APache2（见https://www.drupal.org/docs/system-requirements/web-server-requirements）

我们许多人使用包含的 Lando 文件来运行本地 docker 环境，以便进行测试和开发，但有些人更喜欢在其主机机器上本地运行 Web 服务器。

PHP 要求

我们遵循 Drupal 的 PHP 建议：https://www.drupal.org/docs/system-requirements/php-requirements#versions

我们目前推荐并针对 PHP 8.1 和 8.2 进行测试。

您还需要启用某些 PHP 扩展（见https://www.drupal.org/docs/system-requirements/php-requirements#extensions），包括

PHP mbstring
PHP cURL
GD 库
XML

如果您在运行 composer require 时看到错误，请再次检查您的 PHP 扩展。

默认内容的开发者备注

此配置文件使用 https://www.drupal.org/project/default_content 模块创建单个演示内容的节点。

此节点包含布局段落和段落内容，以展示为新微站提供的一些内容组件。创建新微站时，它会尝试将此节点克隆到新微站中。

作为开发者，我们经常想使用drush更新默认内容。

导出内容项及其所有引用

lando drush dcer <entity type> <entity id> --folder=profiles/contrib/localgov_microsites/content/

因此对于node/1

lando drush dcer node 1 --folder=profiles/contrib/localgov_microsites/content/

Composer和Lando

要本地安装，您需要Composer，我们建议使用Lando以获得一致的开发环境。

请参阅Lando要求部分，了解不同操作系统的Docker要求详情。

https://docs.lando.dev/basics/installation.html#system-requirements

使用Composer在本地安装LocalGov Drupal

要本地安装LocalGov Drupal进行测试或开发，请使用基于Composer的项目模板项目模板。

将MY_PROJECT更改为您想要的项目目录名称。

composer create-project localgovdrupal/localgov_microsites_project --stability alpha --no-install MY_PROJECT

切换到MY_PROJECT目录并运行lando start。

cd MY_PROJECT
lando start

一旦Lando构建完成，使用Lando运行composer install和站点安装程序。

lando composer install
lando drush si localgov_microsites -y

注意：由于您在主机机器上运行的是Lando运行的PHP的不同版本，建议在Lando内部运行composer install。这确保了依赖项反映了实际运行的Web服务器上的PHP版本。

Composer说明

如果您在本地开发并希望强制composer从源克隆而不是使用composer缓存，可以添加--no-cache标志。

lando composer create-project localgovdrupal/localgov_microsites_project --stability alpha --no-cache --no-install  MY_PROJECT

如果您只想拉取LocalGov Drupal的最新更改，请使用--no-cache标志运行composer update。

lando composer update --no-cache

如果您想在开发时确保获取最新的提交，清除composer缓存、删除文件夹并重新运行composer update似乎是一个可靠的方法。

rm -rf web/profiles/contrib/ web/modules/contrib/ web/themes/contrib/;
composer clear-cache; composer update --with-dependencies --no-cache;
lando start;
lando drush si localgov_microsites -y;

如果您在运行Composer命令时遇到内存限制错误，请使用COMPOSER_MEMORY_LIMIT=-1作为命令的前缀。例如，要安装项目，请运行

COMPOSER_MEMORY_LIMIT=-1 composer create-project localgovdrupal/localgov_microsites_project MY_PROJECT

贡献

请参阅CONTRIBUTING.md以获取当前贡献指南。

问题跟踪

大多数问题都将在此存储库中跟踪https://github.com/localgovdrupal/localgov_microsites/issues。

与特定项目或模块相关的开发问题应在项目存储库中跟踪。

开发设置

目前使用的的主要开发环境是Lando - 一个基于Docker的开发环境，适用于Linux、MacOS和Windows。

@todo 记录Lando设置。

编码标准

Composer已将PHP CodeSniffer作为开发依赖项安装，并配置为使用Drupal编码标准和最佳实践。在提交任何代码之前运行这些是很不错的。所有代码在拉取请求中都应该通过所有CodeSniffer测试。

要使用Lando检查代码，请运行

lando phpcs

要尝试在Lando中自动修复编码错误，请运行

lando phix

编码标准资源

Drupal编码标准

运行测试

包含的phpunit.xml.dist文件包含自动运行LocalGov Drupal测试套件的配置。

要使用Lando运行所有LocalGov Drupal测试，请使用

lando phpunit

要运行特定模块的所有测试，请使用

lando phpunit web/modules/contrib/localgov_my_module

可以使用--filter选项过滤测试。要仅运行特定测试，请使用

lando phpunit --filter=myTestName

测试资源

维护者

此项目目前由以下人员维护

Ekes: https://www.drupal.org/u/ekes
芬恩·刘易斯：https://www.drupal.org/u/finn-lewis
玛丽亚·杨：https://www.drupal.org/u/mariay-0
马克·康罗伊：https://www.drupal.org/u/markconroy
斯蒂芬·考克斯：https://www.drupal.org/u/stephen-cox

localgovdrupal / localgov_microsites

维护者

详情