Skip to main content

odk Adaptor developer README.md

Source: https://github.com/OpenFn/adaptors/tree/main/packages/odk

language-odk

An OpenFn adaptor for building integration jobs for use with the odk API.

Documentation​

View the docs site for full technical documentation.

Configuration​

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

A example expression using the post function​

post('v1/projects', { name: 'Project Name' });

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.