Skip to content

Latest commit

 

History

History
133 lines (94 loc) · 3.59 KB

README.md

File metadata and controls

133 lines (94 loc) · 3.59 KB
Raw

Overview

The onboarding tool is a hapi web application that allows Italian Public Administrations to register their code repositories in Developers Italia.

The repositories are scanned by the crawler that feeds the reuse catalog.

Application flow

  • A Public Administration inserts its data into the system.

  • After clicking Registra, the application sends a confirmation PEC to the address from IndicePA

  • The Public Administration confirms the registration clicking on the link from the PEC.

A single Public Administration can register multiple code repositories.

The private folder and the whitelist.db.json file

The application uses of a directory named private/data, which should contain:

  • A private key, used to generate tokens sent during the registration. If no private keys are present while the application starts, a new one is automatically created

  • whitelist.db.json, with the list of the registered Public Administrations. If no database file is present while the application starts, a new one is automatically created.

For security reasons, that directory:

  • is not committed by default. To run the application, you'll need to create one manually

  • is added to the .gitignore file of this repository

whitelist.db.json file format

The format of whitelist.db.json is:

{
  "registrati": [
    {
      "referente": "John Smith",
      "ipa": "c_a123",
      "url": "https://github.com/undefined",
      "pec": "[email protected]"
    },
    {
      "referente": "Mario Rossi",
      "ipa": "c_a123",
      "url": "https://gitlab.com/undefined",
      "pec": "[email protected]"
    }
  ]
}

An example file is available here.

Get the list of Public Administrations registered through APIs

GET https://onboarding.developers.italia.it/repo-list returns the list of currently registered Public Administrations, in YAML form:

---

registrati:
  -
    timestamp: "2019-05-27T09:45:00.770Z"
    ipa: "c_a123"
    url: "https://github.com/undefined"
    pec: "[email protected]"
  -
    timestamp: "2019-05-28T09:45:00.770Z"
    ipa: "c_a123"
    url: "https://gitlab.com/undefined"
    pec: "[email protected]"

Development

Run the application directly on the developer machine

  1. mkdir private/data

  2. npm install

  3. npm run dev

The server will listen to http://localhost:3000.

Run the application using Docker

  1. Copy the .env.example file into .env and edit the environment variables as it suits you.

    cp .env.example .env

  2. Build the container:

    docker-compose up

Once the container is up, the content will be served at http://localhost:3000

License

The project is distributed under BSD-3 license (SPDX code: BSD-3-Clause). For more information, have a look at the LICENSE file.