GovStack Components

Owned by Steve Conrad
Last updated: Aug 14, 2023
2 min read

In a GovStack implementation, there are several different types of components. In addition, there are components that must be developed to support the testing and compliance process for a particular building block. This document provides a definition of these various components as well as detailing which components are generic (may be used for multiple use cases) and which are specific to a particular use case. This document will also flag any components that are specific to the GovStack sandbox/demonstration platform.

Use Case Dependent

  • Application Frontend. For a particular use case, a user interface will be implemented to provide necessary information to the user and collect any needed information from the user.

  • Application Backend. For a use case, the application backend will manage the flow and business logic needed. The backend will access any local data and make calls to GovStack Building Blocks as needed.

  • Repositories. An application may have a local repository that contains data that is specific for that use case.

  • BB Emulator. This component is applicable only to the GovStack sandbox/demonstration platform. In some cases, a simple/lightweight implementation of a Building Block has been created to provide the needed BB functionality for a particular use case. This reduces the infrastructure load for the sandbox.

Generic

These components may be adapted to a country specific context, but can be generic across multiple use cases in a particular GovStack implementation.

  • BB candidate software. This is a specific software platform that functions as one or more building blocks in a GovStack implementation.

  • Adapter. The adaptor provides a mapping from an existing software platform’s API to the format that is specified by the GovStack BB spec for a particular Building Block

  • BB Configuration files. These are the Docker files and startup scripts that allow a product to be automatically launched and configured in a GovStack environment.

  • Test Harness Scripts. These scripts configure any data or environment that is needed for a candidate application to be able to pass the tests for a particular Building Block in the testing application

  • Repositories. As noted, some repositories may contain use-case specific data. However, there may also be repositories that are needed by multiple applications or use cases.