@opencrvs/toolkit

OpenCRVS toolkit

OpenCRVS toolkit for building country configurations.

File structure

src/
  events/ # re-exports events module from commons package
  lib.ts # standard library. currently empty

Getting started

Development using yarn link

# tsconfig.json references commons. when `tsc --build` is run, both are built.
> yarn build
# If you miss this part you might face issues with types.
> cd dist
> yarn link

Releasing and buiding

While developing

1. Update version number in package.json
2. yarn build
3. npm publish

Through version control

1. Update version number in package.json
2. Create a pull request
3. Once merged, github action will get triggered.

Gotchas, good to know

• All dependencies of the functions and moduless used from packages/commons must be also defined in the package.json of the toolkit. Otherwise someone installing the package will get errors.
• Package is published and should be used without knowledge of rest of the monorepo
• Package exposes /events directory, with types, from packages/commons through the library, others are excluded.