openeuropa / oe_starter_content
OpenEuropa Drupal 模块,包含用于快速启动项目的内容类型。
Requires
- php: >=8.1
- drupal/address: ^1.10
- drupal/core: ^10
Requires (Dev)
- composer/installers: ^2.0
- drupal/composite_reference: ^2.1
- drupal/config_devel: ^1.9
- drupal/core-composer-scaffold: ^10
- drupal/core-dev: ^10
- drupal/entity_browser: ^2.6
- drupal/inline_entity_form: ^1.0-rc15
- drupal/typed_link: ^2.0.1
- drush/drush: ^12
- openeuropa/code-review: ^2.0
- openeuropa/oe_content: ^3
- openeuropa/task-runner-drupal-project-symlink: ^1.0.0-beta6
- phpspec/prophecy-phpunit: ^2
This package is auto-updated.
Last update: 2024-09-04 12:08:05 UTC
README
OpenEuropa 快速启动内容提供了一系列内容类型,用于快速启动项目。
请注意:此项目与oe_content内容类型不兼容。
开发设置
您可以通过以下步骤构建开发网站:
- 安装 Composer 依赖项
composer install
在运行 composer install
后,会自动触发一个后置命令钩子(drupal:site-setup
)。这将将在测试站点的正确目录中创建模块的符号链接,并在测试配置文件(如 phpunit.xml.dist
)中执行令牌替换。
请注意:项目文件和目录通过使用OpenEuropa Task Runner的Drupal项目符号链接命令在测试站点内部进行符号链接。
如果您在项目的根目录中添加了新的文件或目录,您需要重新运行 drupal:site-setup
,以确保它们被正确地符号链接。
如果您不希望重新运行完整的站点设置,您可以简单地运行
$ ./vendor/bin/run drupal:symlink-project
- 通过运行安装测试站点
./vendor/bin/run drupal:site-install
开发网站的web根目录应在 build
目录中可用。
使用Docker Compose
或者,您可以使用提供的配置使用 Docker 和 Docker Compose 来构建开发网站。
Docker提供必要的服务和工具,如web服务器和数据库服务器,以启动网站,无论您的本地主机配置如何。
要求
配置
默认情况下,Docker Compose读取两个文件,一个是 docker-compose.yml
,另一个是可选的 docker-compose.override.yml
文件。按照惯例,docker-compose.yml
包含您的基配置,并且默认提供。重写文件,如其名称所暗示,可以包含现有服务或完全新服务的配置重写。如果服务在两个文件中定义,Docker Compose将合并配置。
有关Docker Compose扩展机制的更多信息,请参阅官方Docker Compose文档。
用法
要开始,请运行
docker-compose up
建议不要将 docker-compose
作为守护进程运行,这样您可以在完成工作后快速关闭它(CTRL+C
)。但是,如果您想将其作为守护进程运行,您必须添加标志 -d
docker-compose up -d
然后
docker-compose exec web composer install docker-compose exec web ./vendor/bin/run drupal:site-install
使用默认配置,开发站点文件应在 build
目录中可用,并且开发站点应在:http://127.0.0.1:8080/build。
运行测试
要运行 grumphp 检查
docker-compose exec web ./vendor/bin/grumphp run
要运行 phpunit 测试
docker-compose exec web ./vendor/bin/phpunit
步骤调试
要启用从命令行进行步骤调试,将 XDEBUG_SESSION
环境变量传递给容器,并赋予任何值
docker-compose exec -e XDEBUG_SESSION=1 web <your command>
请注意,从XDebug 3开始,如果设置了变量但您的客户端没有监听调试连接,则会在控制台输出连接错误消息。该错误消息将导致PHPUnit测试产生假阴性。
要从浏览器中启动步骤调试,请使用浏览器扩展或书签工具设置正确的cookie,例如在https://www.jetbrains.com/phpstorm/marklets/生成的工具。
贡献
请阅读完整文档以了解我们的行为准则以及向我们提交拉取请求的流程。