README

需求

nrwGOV开发者工作流程基于ddev。请阅读ddev文档以了解ddev需求。

以下是对（直接或间接）使用的工具的简要概述

• ddev
• docker
• git
• PHP composer
• 选择一个编辑器。对于高级开发者，我们推荐PHP Storm。
• Drupal drush
• Xdebug用于逐步调试（使用ddev配置xdebug）

此外，我们还使用以下工具，这些工具通常通过PHP Composer安装

• robo - 一个任务运行器，用于管道测试和创建自定义主题
• behat - PHP测试工具
• phpunit PHP单元测试工具
• BackstopJS - 一个基于截图测试的工具（视觉回归测试）

创建新项目

git clone git@bitbucket.org:publicplan/nrwgov_project.git

现在是一个命名您项目的好机会。在此示例中，它将重命名为nrwgov_project_91。

mv nrwgov_project nrwgov_project_91

安装PHP依赖

下载nrwGOV，deGov，nrw_theme以及所有其他'依赖项'。

cd nrwgov_project_91
composer install

启动ddev开发环境

ddev使用Docker镜像来构建环境。例如，这是一个Web服务器、数据库服务器和Solr（搜索索引）服务器。

可以同时管理多个ddev环境（例如，用于不同项目或版本）。为此，需要调整端口设置。

定义端口

以下变量需要在.ddev/config.yaml中进行调整。在此示例中，我们将使用以下变量

name: nrwgov91
router_http_port: "8818"
router_https_port: "8819"

现在应该可以成功启动项目

cd nrwgov_project_91
ddev start

[...]

Successfully started nrwgov91
Your project can be reached at https://nrwgov91.ddev.site:8819 https://127.0.0.1:60259

注意：要停止所有ddev进程并释放资源：ddev poweroff

常见问题

如果端口已被其他进程占用，则会发生类似以下错误的错误

Failed to start degov:
Unable to listen on required ports, port 80 is already in use

在这种情况下，必须按上述方法调整端口。项目名称也必须是唯一的。至少在启动第二个项目时，必须对其进行调整。

安装nrwGOV

启动ddev后，可以在浏览器中的https://nrwgov91.ddev.site:8819访问Drupal安装页面。这是一个Drupal标准，我们在这里不详细介绍。

使用演示内容安装nrwGOV

为了开发nrwGOV或快速了解其功能，建议使用演示内容模块（degov_demo_content）。

为了复制一个开发状态，有一个名为kickstart的ddev 自定义命令。注意：ddev kickstart 将删除当前项目的所有文件和数据。

简要来说，kickstart执行以下操作

• 安装依赖项
• 创建local.settings.php文件
• 删除数据库（drush sql-drop）
• 删除并重新创建sites/default/files中的文件
• 导入当前的nrwGOV稳定数据库。
• 执行Drupal数据库和Locale（翻译）更新

有关详细信息，请参阅nrwgov_project_91/.ddev/commands/web/kickstart。

cd nrwgov_project_91
# Angenommen ddev start und composer install sind abgeschlossen.
ddev kickstart

完成后，您应该可以在https://nrwgov91.ddev.site:8819下看到包含所有预告片的页面。

作为管理员登录

获取管理员登录的推荐方法是使用drush user-login（drush uli）。使用ddev，操作如下

cd nrwgov_project_91
ddev drush uli

ddev简要介绍

我们建议您阅读ddev文档。您可以使用drush命令和许多其他功能。以下是一些示例

# Alle ddev Befehle im Projekt anzeigen
ddev

# Übersicht über die ddev Konfiguration des aktuellen Projekts
ddev describe

# Drush Befehle ausführen
ddev drush <drush command>

# Kommandozeilenlogin auf dem (docker) webserver
ddev ssh

# ddev neu starten (z.B. nach einer Änderung der ddev-Konfiguration)
ddev restart

# Ausschalten aller ddev (docker) Dienste
ddev poweroff

# Datenbank mit Sequel Pro (macOS) anzeigen
ddev sequelpro

# Xdebug starten
# See https://ddev.readthedocs.io/en/stable/users/step-debugging
ddev xdebug

缓存和调试

使用ddev kickstart时，大多数缓存已禁用。我们使用Drupal标准方法进行此操作。

如何操作以及如何在浏览器检查器中显示所使用的各个Twig模板的详细信息，请参阅这里的简要介绍。

Xdebug

Xdebug允许调试和性能分析。为了使其正常工作，可能需要配置开发环境。

Drush命令也可以进行调试。以下是一个示例

ddev xdebug
ddev exec PHP_IDE_CONFIG=serverName=nrwgov91.ddev.site /var/www/html/vendor/drush/drush/drush updb -y

前端主题

nrwGOV使用基于Bootstrap的Base主题。

有关nrwGOV Base主题的所有信息，请参阅docroot/themes/nrw/nrw_base_theme/README-DE.md

最后

我们——deGov / nrwGOV 开发团队——经常这样做。我们不会阅读README文件，有时对文档中的错误视而不见，并认为某些事情是理所当然的，而其他人可能从未听说过。

请帮助改进文档

开源软件的生命力在于参与。改善文档是贡献的最简单方式 ：)

来源：https://bitbucket.org/publicplan/nrwgov_project/src/HEAD/README.md