centarro/commerce-kickstart-project

Centarro Commerce Kickstart 3.x 项目模板

3.x-dev 2023-12-22 15:38 UTC

This package is auto-updated.

Last update: 2024-09-22 17:18:51 UTC


README

使用 Composer 获取 Drupal + Centarro Commerce Kickstart 3.x。

还可以查看 drupalcommerce/demo-project,以获取带有示例内容的版本。

使用方法

首先您需要 安装 composer

注意:以下说明针对 全局 composer 安装。您可能需要将 composer 替换为 php composer.phar(或类似)以适应您的设置。

之后您可以创建项目

composer create-project -s dev centarro/commerce-kickstart-project kickstart

完成!使用 composer require ... 下载额外的模块和主题。例如,如果您想安装完整的演示商店,则更改到目标目录并要求 commerce_demo

cd kickstart
composer require drupal/commerce_demo:^3.0

composer create-project 命令将所有文件的所有权传递给创建的项目。您应该创建一个新的 git 仓库,并将所有 .gitignore 文件中未排除的文件提交。

模板做了什么?

  • Drupal 安装在 web 目录中。
  • 模块(类型为 drupal-module 的包)放置在 web/modules/contrib/
  • 主题(类型为 drupal-theme 的包)放置在 web/themes/contrib/
  • 配置文件(类型为 drupal-profile 的包)放置在 web/profiles/contrib/
  • 创建默认的可写版本的 settings.phpservices.yml
  • 创建 web/sites/default/files 目录。
  • 在本地安装最新版本的 DrupalConsole,以便在 bin/drupal 中使用。

更新 Drupal 核心版本

此项目将尝试保持您的所有 Drupal 核心文件是最新的;项目 drupal/core-composer-scaffold 用于确保每次 drupal/core 更新时,您的支架文件都会更新。如果您自定义了任何“支架”文件(通常是 .htaccess),则当您的修改文件在 Drupal 核心的新版本中更新时,您可能需要解决冲突。

按照以下步骤更新您的核心文件。

  1. 运行 composer update drupal/core drupal/core-dev --with-dependencies 来更新 Drupal 核心和其依赖项。
  2. 运行 git diff 以确定是否有任何支架文件已更改。审查文件以查看任何更改,并将对 .htaccessrobots.txt 的任何自定义设置恢复。
  3. 一次性提交所有内容,以确保在检出分支或运行 git bisect 时,webcore 保持同步。
  4. 如果在步骤 2 中出现非平凡的冲突,您可能希望在这些步骤上执行分支,并使用 git merge 将更新的核心文件与您的自定义文件合并。这有助于使用 三向合并工具,如 kdiff3。如果您的更改很简单,则不需要此设置;将所有修改保持在文件的开头或结尾是一个很好的策略,以保持合并简单。

从现有项目生成 composer.json

使用 “Composer Generate” drush 扩展,您现在可以从现有项目生成基本的 composer.json 文件。请注意,生成的 composer.json 可能与此项目的文件不同。

常见问题解答

我应该提交我下载的贡献模块吗?

Composer推荐提交。它们提供了反对提交的理由,但也提供了解决方案,如果项目决定无论如何都要这么做。

我应该提交脚手架文件吗?

Drupal Composer Scaffold插件可以将脚手架文件(如index.php、update.php等)下载到项目的web/目录。如果您没有自定义这些文件,可以选择不将这些文件提交到版本控制系统(例如git)。如果您的项目是这样的,那么在每次安装或更新项目后自动运行drupal-scaffold插件可能会很方便。您可以通过在composer.json中将@composer drupal:scaffold注册为post-install和post-update命令来实现。

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer drupal:scaffold",
        "..."
    ]
},

我如何将补丁应用到下载的模块中?

如果您需要应用补丁(根据正在修改的项目,pull request通常是一个更好的解决方案),您可以使用composer-patches插件。

要将补丁添加到drupal模块foobar中,在composer.json的extra部分插入patches部分。

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL to patch"
        }
    }
}

我如何使用composer.json添加js/css库?

使用Composer安装JavaScript库是可能的,就像这个项目所做的那样,下载包在docroot之外,并将必要的文件复制到Drupal库目录。我们之前依赖于asset-packagist来完成此操作,但在仓库失效后,我们不得不改变我们的方法。有关更多信息,请参阅这篇教程

如何指定PHP版本?

本项目支持PHP 8.1作为最低版本(见Drupal PHP要求),然而,在执行composer update时,可能需要升级某些包,这将需要更新版本。

为防止这种情况,您可以在composer.json的config部分添加以下代码来指定您希望使用的PHP版本。

"config": {
    "sort-packages": true,
    "platform": {
        "php": "7.1.21"
    }
},