DB Schema Diagram

The DB tables provide the registry maps as given below:

API Specs

Find below the Open API specifications defined for this guide:

Birth Registration

Process Workflow Diagram

Registries

As a part of this guide, we are going to build a single birth registry. We will re-use the user registry from the DIGIT core. This will capture the mother and father details and store them in the user registry. The baby's details will remain in the birth registry.

Services

A single birth service will manage the registry.

System Architecture Diagram

Checklist

Before starting development on top of DIGIT make sure:

• To check out the page to learn how to deploy the required tools.

• DIGIT code from DIGIT-OSS, egov-mdms-data, configs etc.. has been forked from GitHub under your organization’s umbrella account.

• You have access to the forked repositories from your GitHub user account. Note that the user account is different from the organization's account.

• Access a DIGIT environment - FQDN, Access keys etc..The DIGIT environment can be a single VM setup for a development environment. Please refer to these docs for the installation of DIGIT.

• Install DIGIT in a development environment (Single VM setup) by following the .

• It is recommended to deploy the following services in the development environment -

Some of the above services can also be port-forwarded using Kubernetes to bypass user authentication.

• Make sure the following DIGIT services are running in the local environment:

  • (optional)

• has been set up for DIGIT. This is a pre-requisite to deploying new DIGIT modules. CD/CI processes will be used to build and deploy the new module that will be developed.

• In addition, knowledge of the following technologies is required for developing on DIGIT: (Refer to the for help with installing and deploying these tools)

  • Java/J2EE

  • Spring Boot

  • REST APIs and related concepts like path parameters, headers, JSON etc.

  • Git

  • PostgreSQL

  • Kafka

Overview

Follw the steps outlined on this page to setup the DIGIT development environment.

Steps

To setup the DIGIT development environment -

1. Run the Kafka and PostgreSQL on the development machine and re-use other services from the DIGIT development environment. The following tools are required for development:

   • Install Git

   • Install JDK8

   • Install IDE - For creating SpringBoot/Java applications we recommend using IntelliJ IDE. IntelliJ can be downloaded from the following links -

   • Install the Lombok plugins for IntelliJ as we use Lombok annotations in this module.

   • Install Kafka (version 3.2.0 which is the latest version) - To install and run Kafka locally, follow the following links -

   • Install Postman - To install postman, follow the following links -

   • Install Kubectl - Kubectl is the tool that we use to interact with services deployed on our sandbox environment -

   • Install aws-iam-authenticator - (if the DIGIT development environment is in AWS) -

   • Install PostgreSQL v10 locally

2. Add configuration - Post installation of kubectl, add the following configuration in the Kubernetes config file to allow access to resources present in our sandbox environment. Kubernetes config file is usually present in the user's home directory (which varies from OS to OS).

   For example, on a Mac, it is present at:/Users/xyz/.kube/config

   Once the config file is created, add the following content to it.

Once the configuration file is created, access the pods running in the environment by typing: kubectl get pods

This lists all the pods in the development environment.

The are the inputs to the development phase.

The docs below guide you through the steps and the resources required to build and design the module.

This section provides the complete details of the system pre-requisites, prepping and setting up the system for development.

Follow the steps in the docs resources below: