italia/developers-italia-onboarding

Developers Italia Onboarding

!Build Status !Issues !License

通过onboarding应用，公共行政部门（PA）可以在Developers Italia门户上注册其代码托管仓库。这样可以将仓库添加到门户爬虫的索引列表中，爬虫会填充复用目录。

Developers Italia

有关Developers Italia项目的更多信息，请访问[***]

应用流程

• PA输入组织相关数据。使用“行政部门搜索”功能，系统会自动填充“iPA代码、行政部门和PEC”字段。

• 点击“注册”按钮后，应用会向表单中指定的行政部门***发送一封PEC邮件。

• 发送的邮件中包含确认注册的链接，点击链接后会重定向到确认页面。

• 在确认页面点击“注册”后，行政部门即被注册到系统中。

如流程所示，同一PA可以注册多个公共代码仓库的URL。

private文件夹与whitelist.db.json文件

应用使用名为private/data的本地文件夹，该文件夹必须包含：

• 用于生成注册时发送给PA的邮件令牌的私钥（软件运行后自动生成）

• 数据库文件whitelist.db.json，包含已注册PA的列表（应用首次启动时可为空）

出于安全考虑，该文件夹：

• 默认不提交到代码库。若要本地运行，需在克隆仓库后在根目录创建该文件夹

• 已添加到本仓库的.gitignore中

whitelist.db.json格式

如前所述，已注册的PA保存在本地JSON文件whitelist.db.json中。文件结构如下：

json
{
  "registrati": [
    {
      "referente": "pluto",
      "ipa": "c_a123",
      "url": "https://github.com/undefined",
      "pec": "protocollo.comunemaramao@pec.it"
    },
    {
      "referente": "pluto",
      "ipa": "c_a123",
      "url": "https://gitlab.com/undefined",
      "pec": "protocollo.comunemaramao@pec.it"
    }
  ]
}

示例文件可参考此处。

API - 已注册PA列表

调用返回已注册PA列表的API，使用URL http://localhost/repo-list。返回格式如下：

yaml
---

registrati: 
  - 
    timestamp: "2019-05-27T09:45:00.770Z"
    ipa: "c_a123"
    url: "https://github.com/undefined"
    pec: "protocollo.comunemaramao@pec.it"
  - 
    timestamp: "2019-05-28T09:45:00.770Z"
    ipa: "c_a123"
    url: "https://gitlab.com/undefined"
    pec: "protocollo.comunemaramao@pec.it"

支持的仓库

目前支持以下代码仓库：

• https://github.com

• [***]

• [***]

• [***]

• [***]

• [***]

该列表会持续更新。

开发与调试环境

应用可在本地运行，既可直接在开发者机器上运行，也可通过Docker容器运行。无论使用哪种方式，都需先克隆仓库到本地文件夹。

复制.env.example文件为.env，根据需要修改环境变量。

直接在开发者机器运行（npm/yarn）

要直接在开发者机器上运行应用，需安装依赖。在克隆的文件夹中执行以下命令：

bash
npm install

在仓库根目录创建private/data文件夹，在其中创建空文件whitelist.db.json（或从[demo-data/whitelist.db.json]复制）。

然后可通过以下命令启动服务器：

bash
npm run dev

该命令通过nodemon在本地创建开发服务器（localhost），文件变更时自动重载，便于开发测试。现在可在浏览器中访问UI，地址为localhost:3000。

Docker

应用在生产环境中以Docker镜像形式分发和使用。为方便使用，除Dockerfile外，还提供docker-compose.yaml文件。

Docker Compose会将whitelist.db.json文件挂载到容器的private/data/目录。

创建并启动容器：

bash
docker-compose up [-d] [--build]

其中：

• -d：后台运行容器

• --build：强制构建容器

销毁容器：

bash
docker-compose down

许可证

本项目采用BSD 3-Clause License许可（SPDX代码：BSD-3-Clause）。更多信息请参见LICENSE文件。