Skip to main content

ghana-bdr Adaptor developer README.md

Source: https://github.com/OpenFn/adaptors/tree/main/packages/ghana-bdr

language-ghana-bdr

An OpenFn adaptor for building integration jobs for use with the Ghana Births and Deaths Registration (BDR) API.

There is no public documentation for the Ghana HBDRP, but the the BDR itself can be reached at https://bdr.gov.gh/

Documentation​

View the docs site for full technical documentation.

Configuration​

View the configuration-schema for required and optional configuration properties.

The adaptor uses token-based authentication:

  • Provide your base URL in configuration.baseUrl (e.g., https://bdrbeta.npontu.com)
  • Provide your long-lived API token in configuration.token

Development​

Clone the adaptors monorepo. Follow the "Getting Started" guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To build only the docs run pnpm build docs.