itzbund/gsb-sitepackage

GSB 11 站点包 - 您需要定义基于 GSB-11 的 Web 项目的所有内容。


README

TYPO3 12


<img src="https://produkt.gsb.bund.de/SiteGlobals/Frontend/Images/logo.png?__blob=normal&v=1" alt="Logo" width="300">

GSB 11 站点包 Kickstarter

Jumpstart your GSB&nbsp;11 powered tenant development.
<br>
<br>
<a href="https://demo.gsb-itzbund.de/">See the Demo</a>
<small><small>(you'll need a username & password)</small></small>

关于

GSB 站点包 Kickstarter 将帮助您开始 GSB 11 租户开发。完成以下步骤后,您将拥有一个本地开发环境,其中包含示例内容并已启动。您将能够将您的租户配置和开发提交到您的租户 GitLab 仓库。

租户概要

请首先查看 租户概要,并将其作为您租户 GSB 11 项目所有问题的参考。

先决条件

您需要事先准备一些东西

  • ddev 已安装到您的计算机上
  • 计算机上安装了 php 版本 8.2,包括所需的扩展
  • composer 已安装到您的计算机上
  • GSB 11 GitLab 或 OpenCoDE 的登录详情(用户名、密码)
  • (仅限 GSB 11 GitLab) 部署令牌(用户名、密码)用于 GSB 11 GitLab
  • (仅限 GSB 11 GitLab) SSH 密钥设置 用于与 GitLab 通信
  • (仅限 GSB 11 GitLab / 租户开发) 您自己租户站点包 Git 仓库的 Git 远程地址

如果您使用 OpenCoDE 的准备

  1. 通过 OpenCoDE 进行身份验证

    composer config -g gitlab-domains gitlab.opencode.de
    composer config -g repositories.gsb-sitepackage vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb-sitepackage-kickstarter.git
    composer config -g repositories.a11y-backend vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/a11y_backend.git
    composer config -g repositories.captainhook-hooks vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/captainhook-hooks.git
    composer config -g repositories.gsb-core vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_core.git
    composer config -g repositories.gsb-feusermanagement vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_feusermanagement.git
    composer config -g repositories.gsb-metadata-cleaner vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_metadata_cleaner.git
    composer config -g repositories.gsb-widgets vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_widgets.git
    

    设置用户名和密码(使用您的个人访问令牌作为密码)

    composer config -g gitlab-token.gitlab.opencode.de <PASSWORD>
    

如果您使用 git.gsb-itzbund.de 的准备

  1. 通过 GSB 11 GitLab 进行身份验证

    composer config -g gitlab-domains git.gsb-itzbund.de
    composer config -g repositories.63 composer https://git.gsb-itzbund.de/api/v4/group/63/-/packages/composer/packages.json
    

    设置用户名和密码

    composer config -g gitlab-token.git.gsb-itzbund.de <PASSWORD>
    

安装

注意

我们团队使用 Linux 和 macOS,因此 Windows 设置可能无法无错误运行。

如果您在 Windows 上开发,请使用 WSL2 中的 ddev,并在 Linux shell 中输入以下命令。

如果您发现错误,请贡献您的解决方案。

按照步骤设置一个 GSB 11 网站,并将此站点包作为 composer 根包。

  1. 创建 GSB 11 项目

    composer create-project itzbund/gsb-sitepackage gsb11-mandant && cd gsb11-mandant
    

    如果此命令失败,请尝试此解决方案。

    cd gsb11-mandant
    composer config --unset repositories.63
    composer install
       
    

    或者 从 composer.json 中删除以下内容

        "repositories": {
             "63": {
                 "type": "composer",
                 "url": "https://git.gsb-itzbund.de/api/v4/group/63/-/packages/composer/packages.json"
             }
         }
       
           
     than run composer install
    
  2. 启动本地开发环境

    ddev start
    
  3. 仅限 GSB 11 GitLab! 添加附加扩展

    包括 "联邦样式指南" 的模板

     composer require itzbund/gsb-frontend
    

    示例内容

     composer require itzbund/gsb-distribution
    
  4. 安装 GSB 11

    ddev exec cp .composer/vendor/typo3/cms-install/Resources/Private/FolderStructureTemplateFiles/root-htaccess .build/public/.htaccess && \
    ddev exec .composer/bin/typo3 setup --force \
    --no-interaction \
    --server-type=apache \
    --driver=mysqli \
    --username=db \
    --password=db \
    --port=3306 \
    --host=db \
    --dbname=db \
    --admin-username=admin \
    --admin-user-password=Pas§§wor1 \
    --admin-email='' \
    --project-name="GSB11" \
    --create-site="https://gsb-sitepackage.ddev.site"
    

    注意:此配置仅在本地开发环境中使用。 在部署过程中将丢弃此配置! 请使用安全的密码

  5. 安装扩展

    ddev exec .composer/bin/typo3 extension:setup
    

    仅限 GSB 11 GitLab! (可选) 您可以删除分发扩展。虚拟内容(页面树和文件)已加载。该扩展现已过时。

    ddev composer remove itzbund/gsb-distribution
    
  6. 启动项目

    ddev launch
    
  7. 登录后端

    在您的浏览器中访问 https://gsb-sitepackage.ddev.site/typo3 或使用

    ddev launch /typo3
    

    注意:您在步骤 4 "安装 GSB 11" 中定义了用户名和密码。

  8. 仅限 GSB 11 GitLab! 初始化 Git 并添加远程仓库

    git init --initial-branch=main
    git remote add origin https://git.gsb-itzbund.de/gsb11/sitepackages/<NAME OF YOUR TENANT SITEPACKAGE REPOSITORY>
    git add .
    git commit -m "Initial commit"
    git push --set-upstream origin main
    
  9. 配置您的 GSB 11 租户 🚀

备注

有关更多信息,请参阅扩展的 README 文件。可用的扩展列表包含在授权概要中。

开发

GSB 11中缓存说明以及在开发中的CI/CD管道说明存储在GSB 11 GitLab文档项目中。

要成功发布GSB 11的正式版本,必须使用基于trunk的开发来开发站点包,其中main是标准分支。将代码合并到release分支将触发稳定版本的发布。必须使用mainrelease分支。

贡献

与TYPO3一样,我们鼓励您通过提交更改来加入项目。GSB 11的开发主要发生在GSB 11 TYPO3扩展中。

要开始,请查看我们的详细的贡献流程