palantirnet/drupal-skeleton

此包最新版本(3.1.0)没有可用的许可信息。

Drupal 10项目模板。

3.1.0 2022-10-20 16:40 UTC

README

这是一个使用composer create-project命令开始Drupal项目的模板。

快速入门

本“快速入门”部分将向您展示如何设置一个本地服务器,该服务器可通过http://example.local访问,并准备好安装Drupal。

前言

在您开始之前,应在Mac上安装开发依赖项。这些依赖项不是项目特定的,您可能已经安装了其中一些或全部。如果没有,找到网络良好的位置,并留出至少一个小时来完成此步骤。

开发依赖项包括

在Mac上,可以使用homebrew安装Docker和ddev

  • brew install docker --cask
  • brew install ddev

安装好依赖项后,设置此骨架至少需要另一个小时,具体取决于您的网络连接。

以下一些命令将提示您进行响应,括号中的是默认答案。对于此快速入门,按回车键接受每个默认答案

Enter a short name for your project [example] :

步骤

  1. 基于此模板创建一个新的名为“example”的Drupal 10项目

    composer create-project palantirnet/drupal-skeleton example dev-develop --no-interaction
    
  2. 进入您的新项目目录,并在.ddev/config.yml中更新ddev配置

    # Update to match your project name. Using "drupal-skeleton" would make the site
    # accessible at 'drupal-skeleton.ddev.site'.
    name: drupal-skeleton
    
    # Use 'docroot' for Acquia, or 'web' for Pantheon or Platform.sh.
    docroot: web
    
  3. 在ddev环境中,从palantirnet/the-build运行脚本以设置默认Drupal变量并安装Drupal

    ddev start
    ddev ssh
    vendor/bin/the-build-installer
    
  4. 在您的网页浏览器中,访问http://example.ddev.site

  5. 可选: 当您登录到ddev环境时,您可以运行Drush命令,如drush status

额外加分

  • 将此README.md替换为README.dist.md,然后根据您的项目进行自定义
  • 更新composer.json文件中的项目名称,然后运行composer update --lock
  • 初始化git仓库并提交您的作品
  • 通过phpMyAdmin访问您的数据库
  • https://example.ddev.site:8026查看您开发站点发送的电子邮件
  • 使用search_api_solr模块连接到您的Solr服务器

注意:请确保您的项目目录位于正确的位置/名称正确,因为启动后重命名或移动项目目录(例如example/)可能会破坏您的ddev设置。

完整项目设置

创建一个具有自定义名称的项目

使用Composer根据此骨架创建一个新项目,将PROJECTNAME替换为您的项目的简称

composer create-project palantirnet/drupal-skeleton PROJECTNAME dev-develop --no-interaction

更新您的文档

更新README

  • 删除README.md
  • README.dist.md重命名为README.md
  • 随意编辑

项目特定文档请参阅docs/technical_approach.md

  • 添加deployment.md用于部署说明

更新LICENSE.txt

  • 删除或替换此文件,以使用适合您项目的适当许可协议。(现有许可协议仅适用于Drupal模板。)

更新composer.json

  • namepalantirnet/drupal-skeleton更改为palantirnet/PROJECTNAME
  • 使用项目简要描述更新description
  • 根据您的工作许可方式更新license属性
  • 更新锁文件,以免composer报错
  composer update --lock

更新package.json

  • namepalantirnet--drupal-skeleton更改为palantirnet--PROJECTNAME(见package.json命名要求
  • 使用项目简要描述更新description

配置您的ddev开发环境

进入您的新项目目录,更新.ddev/config.yml中的ddev配置。

运行安装程序

在ddev内部运行palantirnet/the-build中的脚本以设置基本Drupal安装

ddev start
ddev ssh
vendor/bin/the-build-installer

将您的作品提交到git

初始化git仓库并将您的作品提交到develop分支

git init
git checkout -b develop
git commit --allow-empty -m "Initial commit."
git add --all
git commit -m "Add the skeleton."

GitHub上为您的作品创建一个空仓库。然后,将您的作品推送到该仓库

git remote add origin git@github.com:palantirnet/PROJECTNAME.git
git push -u origin develop

管理您的ddev环境

  • 启动ddev:ddev start
  • 登录:ddev ssh
  • 登出(就像您从任何其他ssh会话中退出一样):exit
  • 关闭ddev:ddev stop
  • 查找有关您的ddev环境的信息:ddev describe
  • 另请参阅ddev文档

将"the-build"替换为[其他内容]

如果您对phing过敏,而Benadryl没有帮助,您也可以删除-the-build

  1. composer remove --dev palantirnet/the-build

  2. rm -r .the-build

  3. rm build.xml

  4. 这将删除drush、coder和phpmd -- 如果您需要这些依赖项,您需要将它们添加回您的项目

    composer require --dev drush/drush drupal/coder phpmd/phpmd
    
  5. 安装您选择的构建工具...或者什么都不做...

  6. 更新您的项目README

另请参阅:使用the-build的文档

从命令行安装Drupal

当使用drushphing管理您的Drupal站点时,您需要登录到ddev环境(ddev ssh)。

如果您已在ddev内部运行了vendor/bin/the-build-installer,Drupal将被安装,并将初始配置导出到config/sites/default/

您可以使用由palantirnet/the-build提供的phing脚本在任何时候重新安装站点配置

vendor/bin/phing install

或者,您可以直接使用drush

drush site-install --existing-config

以代码的方式管理您的配置

在Drupal开发中,所有(或大多数)Drupal配置都应该导出并作为代码库的一部分处理。我们使用Drupal的“从配置安装”安装选项,允许我们使用导出的配置作为可重复、自动化友好的构建和安装过程的依据。我们还使用config_split来管理环境特定的配置。

  1. 在浏览器中登录到Drupal并做一些基本的配置自定义

    • 设置站点时区
    • 禁用按用户时区
    • 禁用用户账户创建
    • 删除不必要的内容类型
    • 设置管理员电子邮件地址(您的开发环境将捕获所有电子邮件)
    • 将Cron间隔降低到“从不”
    • 卸载不必要的模块(例如搜索、历史、评论)
  2. 导出您的配置

    drush cex -y
    
  3. 您应该在 config/sites/default/ 目录中拥有大量的新 *.yml 文件。将它们添加到 git 中,并记录这次配置更改

    git add config/
    git ci -m "Initial Drupal configuration."
    git push
    
  4. 重新安装您的站点并验证配置是否就绪

    vendor/bin/phing install
    

更多信息

版权所有 2016 - 2021 Palantir.net, Inc.