Skip to main content

copper Adaptor developer README.md

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

language-copper

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

Documentation​

View the docs site for full technical documentation.

Configuration​

Copper API key auth requires the access token plus the email of the user who generated it. See the Copper authentication docs for details.

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

The configuration schema uses JSON Schema draft-07. Run pnpm validate:schemas from the adaptors repo root after editing it.

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.