Repository files navigation

https://onboarding.developers.italia.it

The onboarding tool is ahapi web application thatallows Italian Public Administrations to register their code repositories inDevelopers Italia.

The repositories are scanned by thecrawler that feeds thereuse catalog.

• A Public Administration inserts its data into the system.

• After clickingRegistra, the application sends a confirmationPECto the address fromIndicePA

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

A single Public Administration can register multiple code repositories.

The application uses of a directory namedprivate/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 oneis 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 isautomatically created.

For security reasons, that directory:

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

• is added to the.gitignore file of this repository

The format ofwhitelist.db.json is:

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

An example file is availablehere.

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

---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"

1. mkdir private/data

2. npm install

3. npm run dev

The server will listen tohttp://localhost:3000.

1. Copy the.env.example file into.env and edit theenvironment 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 athttp://localhost:3000

The project is distributed under BSD-3 license (SPDX code:BSD-3-Clause). Formore information, have a look at theLICENSE file.