Digital Citizenship

This is the main repository of the Digital Citizenship project, managed by AgID and the Digital Transformation Team.

This repository stores technical documentation and code, for a more friendly introduction on the topic, check out the following pages (Italian):

• The Digital Citizenship project page in the Digital Transformation Team site for high level introduction.
• The Digital Citizenship documentation site for more indepth explanation of the project components and goals.

Child projects

The Digital Citizenship APIs

• backlog
• API source
• docs

The Digital Citizenship mobile app

• backlog: app and app backend
• code: app and app backend

Contributing

Architecture decision records

In a world of evolutionary architecture, it's important to record certain design decisions for the benefit of future team members as well as for external oversight. Architecture Decision Records is a technique for capturing important architectural decisions along with their context and consequences. We store these details in source control, along with code, as then they can provide a record that remains in sync with the code itself.

We use ADRs to track architectural decisions of this initiative.

This repository is configured for Nat Pryce's adr-tools.

Here's the decisions we taken so far:

ADR	Title	PR (discussion)
1	Record architecture decisions
2	Use OpenAPI to define the API specs	PR#3
3	Follow a cloud native design principle	PR#4
4	Minimize lock-in to a particular cloud provider or feature	PR#5
5	We chose Microsoft Azure as our primary cloud provider	PR#6
6	Choice of primary key for citizen data	PR#9
7	Choice of Azure region	PR#11
8	Choice of backend language	PR#12
9	We choose a CosmosDB API	PR#13
10	We select an Azure app hosting service	PR#27
11	We chose a different CosmosDB API	PR#28
12	We chose a retry strategy in case of processing errors	PR#48
13	We decide how to expose the app backend to the internet	PR#52

Other

Building the documentation site

The source of the Digital Citizenship documentation site is under the docs directory of this repository.

Prerequisites

• Python language runtime
• Python pip
• Sphinx

Then install the following packages:

pip install recommonmark
pip install sphinx-rtd-theme

Build the documentation

To build the sphinx documentation from this repository:

yarn docs:build

Publish the documentation

To deploy the documentation site (via GitHub pages):

yarn docs:publish