ymcatwincities/openy-docksal

基于开源工具 http://docksal.io 开发的 Open Y 开发环境

安装次数: 44 187

依赖项: 3

建议者: 0

安全性: 0

星标: 2

关注者: 11

分支: 10

开放性问题: 3

类型:docksal-vm

dev-master 2023-02-20 13:28 UTC

This package is auto-updated.

Last update: 2024-09-20 16:42:24 UTC


README

这是一个基于 Docksal 的YMCA网站服务Drupal发行版。

Docksal 被用作本地开发环境。

开始使用

您需要根据 Docksal 安装说明 在本地机器上安装 Docksal。

从头开始完整安装

注意:不需要本地 PHP 和/或 Composer 实例。

按照以下步骤准备完整项目。

安装 Docksal

curl -fsSL https://get.docksal.io | bash

克隆 OpenY docksal 项目

git clone git@github.com:ymcatwincities/openy-docksal.git

添加您的自定义设置

  • .docksal 目录内创建 docksal-local.env 文件,内容如下
YUSAOPENY_PROJECT_VERSION='9.2.x'
YUSAOPENY_VERSION='9.x-2.x'
GIT_REMOTE_UPSTREAM='git@github.com:USER/yusaopeny.git'
IGNORE_CUSTOM='.idea'
  • 使用 OPENY_PROJECT_VERSION 指定要作为 composer 项目使用的 YCloudYUSA/yusaopeny-project 的分支。在大多数情况下,您需要

    • 9.2.x 以使用最新的稳定 yusaopeny 发布版。
    • 9.2.x-development 以使用最新的开发版 yusaopeny。
  • 使用 YUSAOPENY_VERSION 指定要自动检出 YCloudYUSA/yusaopeny 的分支。请注意,yusaopeny 版本对应于根 composer.json 中所需的版本。使用 9.x-2.x 从最新的 yusaopeny 进展开始开发。

  • USER 替换为您的 GitHub 用户名,或者如果您不需要自动设置上游仓库,请删除 GIT_REMOTE_UPSTREAM

  • 在执行 build_project 命令期间,除了忽略的目录外,所有目录都会被删除。如果您正在处理现有的项目并希望保存项目根目录中的任何文件夹,请将文件夹名称添加到 IGNORE_CUSTOM。目录名称应使用空格分隔。

如果您想将您的分支作为原点远程仓库,而将主仓库作为上游远程仓库,请将以下变量添加到 docksal-local.env 文件中,如下所示

GIT_REMOTE_UPSTREAM='git@github.com:YCloudYUSA/yusaopeny.git'
GIT_REMOTE_ORIGIN='git@github.com:USER/yusaopeny.git'

在这种情况下,项目安装后,git 将自动跟踪您指定的 originupstream 远程仓库

构建 Y USA Open YMCA 项目

在项目目录中运行此命令

fin build_project

结果,您将在文件系统中获得完整的 YMCA 网站服务安装。

命令运行期间出现的 "Killed" 消息通常意味着您需要增加 Docksal 的内存限制。对于 macOS 或 Windows,Docker 可用内存总量受虚拟机或 Docker Desktop 设置的限制。

安装 YMCA 网站服务站点

在执行 fin build_project 命令完成后,您需要安装一个站点。为此,您可以使用以下命令之一

  • fin init
  • fin install_steps
  • fin upgrade_init

有关这些命令的更多详细信息,请参阅以下内容。

替代安装过程

# Install Docksal
curl -fsSL https://get.docksal.io | bash
# Change directory to your workspace
fin run-cli composer create-project YCloudYUSA/yusaopeny-project yusaopeny --no-interaction --no-dev
cd yusaopeny
fin run-cli composer install
fin init

打开设置结束时打印的 URL(例如 http://yusaopeny.docksal.site),以查看最新稳定版本的 YMCA 网站服务的本地副本。

YMCA 网站服务的 Docksal 环境

打开项目的文件夹并运行其中一个命令。

管理员账户为 admin:admin

启动项目

fin init

web 服务器启动,站点将自动使用 drush si 安装。

通过 UI 安装站点

fin install_steps

Web服务器启动后,将为网站提供基本配置。完成后,您需要在浏览器中打开网站,并从用户界面继续安装。此命令适用于测试YMCA网站服务安装表单。

测试升级路径

fin upgrade_init

Web服务器启动后,将从包含预先安装的之前YMCA网站服务版本的YMCA网站服务数据库备份中安装网站。安装完成后,将执行最新YMCA网站服务版本中添加的所有新更新。

如何开发?

在运行"fin init"并准备好您的环境后,您需要做一些事情。

  • https://github.com/YCloudYUSA/yusaopeny创建一个分支。
  • 在您的项目中,转到docroot/profiles/contrib/yusaopeny并编辑.git/config文件。将仓库URL替换为您的全新分支。
  • 然后您可以在您的仓库中创建一个分支,推送一些代码,然后创建一个拉取请求返回到YCloudYUSA/yusaopeny仓库。

如何运行behat测试?

编辑behat.local.yml并将base_url设置为web,将wd_host设置为http://browser:4444/wd/hub。然后您可以使用./vendor/behat/behat/bin/behat运行您的behat测试。