Skip to content

SND-648 Update documentation. Add local development part. #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oleksiidn wants to merge 2 commits into
base: main
Choose a base branch
from
Open

SND-648 Update documentation. Add local development part. #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6736ac4
Update documentation. Add local development part.
oleksiidn Nov 20, 2023
3ae0600
Update documentation
oleksiidn Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions docs/main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -61,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 identifiable records in a database.

GovStack specification [link](https://govstack.gitbook.io/bb-digital-registries/2-description).

OpenIMIS is package provider.
USCT heavily uses packages. To improve performance USCT uses cache for package to avoid redundant requests.
### OpenIMIS
USCT uses OpenIMIS as package provider.

[Packages](packages.md) pages has more technical details.
[Packages](packages.md) page has examples of package.

### Adapter
Originaly OpenIMIS base on [Fast Healthcare Interoperability Resources](https://en.wikipedia.org/wiki/Fast_Healthcare_Interoperability_Resources) (FHIR) standard.
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).

The [adapter](https://github.com/openimis/openimis-be-govstack_api_py) provides Govs OpenIMIS specification compliant.

### Example of request
To improve performance USCT uses cache for package to avoid redundant requests.

#### 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).

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/).
Expand Down