common-gateway/huwelijksplanner-bundle

为荷兰市政婚姻功能提供的symfony包

维护者

详细信息

github.com/CommonGateway/HuwelijksplannerBundle

主页

源代码

问题

安装: 310

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 0

开放问题: 4

类型:symfony-bundle

0.0.111 2024-03-15 10:33 UTC

Requires

Requires (Dev)

EUPL-1.2 69d9068f05bb5dbe81da0edefbbc334c095013b0

symfonygatewaycommonconductioncommongatewaycommon-gateway-plugin

This package is auto-updated.

Last update: 2024-09-02 11:06:48 UTC

README

HuwelijksplannerBundle是一个强大的Symfony扩展包，为处理市政范围内的荷兰婚姻请求提供了基本功能。此扩展包专门设计用于简化和管理与婚姻相关的操作，是市政当局不可或缺的工具。

从Huwelijksplanner 2020的变化

在Huwelijksplanner项目的先前版本中，决定将Huwelijksplanner完全分离成单独的登记册，每个登记册作为独立的Common Ground组件开发。这些组件需要独立安装。

然而，这种方法导致了几个问题。需要安装许多组件才能启动Huwelijksplanner，大量的代码库也带来了维护的挑战。

在Huwelijksplanner的当前版本中，我们通过将个别组件重新组织为插件来解决这些问题。这种变化提供了两个主要优势：

  1. 更小的代码库：通过将组件重构为插件，底层代码库现在更易于管理和维护。

  2. 统一的网关安装：这些不同的插件现在可以在单个Common Gateway安装上运行。这简化了部署过程并简化了开发者的设置。

市政当局可以选择在单独的安装中运行组件或将它们组合成统一的设置。

HuwelijksplannerBundle中使用的扩展包

HuwelijksplannerBundle当前使用以下扩展包

  1. CoreBundle: GitHub仓库
  2. BRPBundle: GitHub仓库
  3. KlantenBundle: GitHub仓库
  4. ZGWBundle: GitHub仓库

虽然所有这些扩展包仍然可以作为独立组件安装（请参阅各自的安装指南），但HuwelijksplannerBundle现在默认将这些扩展包作为相同的网关上的附加插件安装。

这种新的方法提供了更大的模块化，使开发者更容易与HuwelijksplannerBundle一起工作，并允许根据个别市政的需求进行更灵活的配置。

如果您有任何问题、建议或新想法，请随时在项目仓库中分享。让我们共同努力创造一个卓越的婚礼策划体验，为即将步入婚姻殿堂的夫妇带来快乐和幸福。

后端安装说明

Huwelijksplanner后端代码库使用Common Gateway作为一个开源安装框架。这意味着Huwelijksplanner库在其核心形式上作为该框架的插件运行。有关Common Gateway的更多信息，您可以参考以下文档此处。

请注意，Huwelijksplanner前端代码库是单独的docker容器。

要安装后端，请按照以下步骤操作

网关安装

  1. 如果您未安装通用网关，可以按照以下安装指南进行安装。后端设置需要安装通用网关。您可以选择任何网关安装方法，如 Haven、Kubernetes、Linux 或 Azure，以及任何数据库选项，如 MySQL、PostgreSQL、Oracle 或 MsSQL。网关框架处理这种抽象。

HuwelijksplannerBundle 安装 - 管理界面

  1. 安装网关成功后，访问管理界面并登录。
  2. 在左侧菜单中，导航到“插件”以查看已安装插件的列表。如果您在这里找不到“Huwelijksplanner”插件，您可以通过点击右上角的“搜索”并输入“Huwelijksplanner”来搜索它。
  3. 点击“Huwelijksplanner”卡片，然后点击“安装”按钮来安装插件。
  4. 管理界面允许您安装、升级或删除包。但是，要加载所有必需的数据（模式、端点、源），您需要在终端中执行初始化命令。

HuwelijksplannerBundle 安装 - 终端

  1. 打开终端并运行以下命令以安装 Huwelijksplanner 包

    docker-compose exec php composer require common-gateway/huwelijksplanner-bundle

初始化命令（终端）

  1. 要加载所有数据而不包含任何特定内容，请执行以下命令

    docker-compose exec php bin/console commongateway:initialize

    或者

    要加载所有数据以及特定内容，请运行

    docker-compose exec php bin/console commongateway:initialize -data

完成这些步骤后，Huwelijksplanner 项目的后端设置应准备好使用。如果在安装过程中遇到任何问题，请寻求开发团队的帮助。祝您编码愉快！

前端安装说明

以下说明将指导您完成 Huwelijksplanner 项目的设置过程。请按照以下步骤开始

先决条件

在开始之前，请确保您的系统上已安装以下软件

  1. Git
  2. Node.js（npm）
  3. Docker
  4. Docker Compose

安装

  1. 在终端中运行以下命令以克隆乌得勒支 Huwelijksplanner 仓库

    git clone https://github.com/frameless/utrecht-huwelijksplanner.git

  2. 在项目目录中找到 .env 文件，并将 NEXT_PUBLIC_API_URL 修改为使用本地 API。将其更改为

    NEXT_PUBLIC_API_URL=https:///api

  3. 在终端中运行以下命令以安装项目依赖项并生成必要的代码

    npm install && npm run codegen

  4. 使用 Docker Compose 构建并启动开发环境

    docker-compose -f docker-compose.dev.yml build
docker-compose -f docker-compose.dev.yml up --remove-orphans

    如果在此步骤中遇到错误，请尝试运行位于仓库中 Docker-compose.yml 下的生产 Docker Compose 文件。成功构建后，您可以重试第 4 步。

完成这些步骤后，Huwelijksplanner 项目的前端设置应准备好使用。如果在安装过程中遇到任何问题，请寻求开发团队的帮助。祝您编码愉快！

管理界面 - 设置说明

后端（和前端）启动并运行后，可以配置 HuwelijksplannerBundle。为了确保正常功能，需要修改源和安全组（默认匿名用户）。其他调整是可选的。

配置步骤

  1. 用户

    • 如果需要，更改用户的密码。建议您更改管理员用户的电子邮件。
      • 转到管理界面的 设置。
      • 导航到 用户 选项卡。
      • 选择用户并编辑密码。

  2. 源

    • 为以下源提供所需的 API 密钥
      • SendInBlue API
      • Mollie API
      • MessageBird API

  3. 操作

    • 在 MessageBird 操作中更改 SMS 的发送者
      • 转到管理界面的 操作。
      • 找到并选择 MessageBird 以查看其详细信息
      • 将 Originator 设置为 SMS 的发送者。

  4. 映射

    • 为合作伙伴和/或见证人配置 SMS 和电子邮件数据
      • 转到管理界面的 映射。
      • 找到并选择 EmailAndSmsDataPartner 或 EmailAndSmsDataWitness 以查看其详细信息
      • 更改 body、assentName、assentDescription 和 url 的值。
        • body 是短信的内容主体
        • assentName 是为此合作伙伴制作的同意的名称
        • assentDescription 是为此合作伙伴制作的同意的描述
        • url 是合作伙伴被引导到的URL，以确认婚姻

完成这些步骤后，Huwelijksplanner管理员界面应该已经完全配置完毕，Huwelijksplanner项目现在可以使用了。

Huwelijksplanner 测试数据 - 开发者指南

以下是Huwelijksplanner中使用的测试数据信息。我们加载了两个包含测试数据的文件：BRP（个人基础登记）BRPTestData.json 和 SDG产品 HuwelijksPlannerTestData.json。

测试数据详情

BRP 测试数据

BRP 测试数据包括BRP系统中注册人员的信息条目，与正在加载的用户相关联。每个用户都有一个包含对应于BRP注册人员对象中BSN（居民服务号码）的 person 属性。

SDG 产品测试数据

SDG产品测试数据包括以下对象

  1. 婚姻类型

    • 转换
    • 合伙关系
    • 婚姻
    • 简单婚姻
    • 闪电/柜台婚姻
    • 免费结婚

  2. 婚姻官员

    • 分配
    • 自己的婚姻官员
    • 选择婚姻官员

  3. 婚姻地点

    • 自己的地点
    • 旅馆
    • 婚礼厅
    • 柜台

  4. 额外产品

    • 婚姻手册

所有SDG产品都有翻译，包含有关产品的附加信息。

这些测试数据文件用于在Huwelijksplanner中填充样本信息，以供测试和开发使用。

在开发工作流程中，请随时探索和利用这些测试数据。

为了更深入地了解HuwelijksplannerBundle提供的服务和命令，我们鼓励您探索可在https://commongateway.github.io/HuwelijksplannerBundle/找到的详细文档。此文档提供了对捆绑包功能、服务使用和可用命令的全面见解。

无论您是从事市政婚礼规划项目开发的开发者还是对HuwelijksplannerBundle感兴趣的热衷者，此文档都是一项无价资源，可帮助您有效地导航和使用捆绑包。

加入我们，利用HuwelijksplannerBundle的力量，为荷兰市政机构创建无缝高效的婚姻请求处理解决方案。编码愉快！