From 6736ac4a24108685b3b7255b5746fa9990f6869b Mon Sep 17 00:00:00 2001 From: oleksiidn Date: Mon, 20 Nov 2023 14:55:42 +0200 Subject: [PATCH 1/2] Update documentation. Add local development part. --- docs/main.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/main.md b/docs/main.md index f664d5c..13a8839 100644 --- a/docs/main.md +++ b/docs/main.md @@ -25,6 +25,14 @@ sequenceDiagram USCT-backend -->> Civil servant: Return result ``` +## Local development + +The purpose of the application is to bring together independent solutions and organize them in such a way as to obtain a demo use case of USCT. +This means that the application has many external dependencies, making local development difficult. +To have a local live application, you need to replace the real application with emulators. + +To do this set emulators in the [application properties](/src/main/resources/application.properties). + ## Authentication / Authorization Application has configurable authentication logic with cookie-based session management: From 3ae06002eab544b441fa58759f94d292174f2042 Mon Sep 17 00:00:00 2001 From: oleksiidn Date: Mon, 20 Nov 2023 20:13:39 +0200 Subject: [PATCH 2/2] Update documentation --- docs/main.md | 51 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 34 insertions(+), 17 deletions(-) diff --git a/docs/main.md b/docs/main.md index 13a8839..acd6533 100644 --- a/docs/main.md +++ b/docs/main.md @@ -4,7 +4,17 @@ This is a driver backend application for [Unconditional Social Cash Transfer](https://github.com/GovStackWorkingGroup/product-use-cases/blob/main/product-use-case/inst-1-unconditional-social-cash-transfer.md) (USCT) use case. -[Live Demo](https://usct.dev.sandbox-playground.com/driver-poc/) +The purpose of the application is to bring together independent solutions (BB) and organize them in such a way as to obtain a demo use case. +This means that the application has many external dependencies, making local development difficult. +To have a local live application, you need to replace the real application with [emulators](https://govstack.gitbook.io/sandbox/explore-stack/building-blocks/emulators). + +To do this set emulators in the [application properties](/src/main/resources/application.properties). + +[DIY](diy.md) version of the application is based on emulators. + +## Live demo + +[Link](https://usct.dev.sandbox-playground.com/driver-poc/) ## Application logic @@ -25,14 +35,6 @@ sequenceDiagram USCT-backend -->> Civil servant: Return result ``` -## Local development - -The purpose of the application is to bring together independent solutions and organize them in such a way as to obtain a demo use case of USCT. -This means that the application has many external dependencies, making local development difficult. -To have a local live application, you need to replace the real application with emulators. - -To do this set emulators in the [application properties](/src/main/resources/application.properties). - ## Authentication / Authorization Application has configurable authentication logic with cookie-based session management: @@ -69,23 +71,38 @@ Mosip uses Foundational ID (VID) | 4893724702 / enrollment-officer | ENROLLMENT_OFFICER | 294629625538148508290996199782510910 | Officer responsible for enrollment | | 2371487382 / payment-officer | PAYMENT_OFFICER | 268505314334796284434550524121540566 | Officer responsible for payment | -## OpenIMIS +## Digital registries + +The Digital Registries Building Block provides services to other Building Blocks and to external systems, to store and manage data/claims on any entity (persons, places, and things) in forms of uniquely identiļ¬able records in a database. + +GovStack specification [link](https://govstack.gitbook.io/bb-digital-registries/2-description). + +### OpenIMIS +USCT uses OpenIMIS as package provider. + +[Packages](packages.md) page has examples of package. -OpenIMIS is package provider. -USCT heavily uses packages. To improve performance USCT uses cache for package to avoid redundant requests. +Onboarding documentation of the OpenIMIS is located in sandbox-bb-digital-registries [repository](https://github.com/GovStackWorkingGroup/sandbox-bb-digital-registries/blob/main/digital-registries/open-imis/docs/1-main.md). -[Packages](packages.md) pages has more technical details. -### Adapter -Originaly OpenIMIS base on [Fast Healthcare Interoperability Resources](https://en.wikipedia.org/wiki/Fast_Healthcare_Interoperability_Resources) (FHIR) standard. +To improve performance USCT uses cache for package to avoid redundant requests. -The [adapter](https://github.com/openimis/openimis-be-govstack_api_py) provides Govs OpenIMIS specification compliant. +#### Adapter +Adaptors are used to map existing APIs and functionality in a Digital Public Good into a format and scheme that is compatible with the GovStack API specifications. For more details check the [link](https://govstack.gitbook.io/sandbox/explore-stack/building-blocks/emulators#emulator-adaptor-implementations). -### Example of request +Originally OpenIMIS base on [Fast Healthcare Interoperability Resources](https://en.wikipedia.org/wiki/Fast_Healthcare_Interoperability_Resources) (FHIR) standard. + + +Adapter implementation is in the openimis-be-govstack_api_py [repository](https://github.com/openimis/openimis-be-govstack_api_py). + +#### Example of request ![Get Packages OpenIMIS](images/getPackages.gif) +### Emulator +For local development and [DIY version](diy.md) use [emulator](https://github.com/GovStackWorkingGroup/sandbox-bb-digital-registries/blob/main/emulator/docs/main.md). + ## Payment Building Block Payments BB is used as payment service that can disburse payment to Beneficiaries which compliant with [specification](https://govstack.gitbook.io/bb-payments/).