inp-client
v1.8.0
Published
Client to communicate with Integration platform
Downloads
7
Readme
inp-client
Integration platform API client
Setup and creating demo integration
- run
npm i
to install dependencies - copy
.env.example
to.env
and update to your values, keep as is for local development - copy
examples/on-demand-endpoint
to your destination, note that folderlocal
is in.gitignore
so you can copy it here:cp -R examples/on-demand-endpoint local
- create a demo integration with
npm run inp-client -- -c local/on-demand-endpoint
- see file created:
local/on-demand-endpoint/created-integration.json
which contains all created resources
Updating scripts
- change something in
local/scripts/hello-world.js
, modify result or add logging - run
npm run inp-client -- -u local/on-demand-endpoint/
, it will load saved integrationcreated-integration.json
and lookup for endpoints and scripts and will update all found.
Local development
There are various ways to develop and test local or unreleased version of inp-client. All requires some change in the target project my preferred way is to remove inp-client from package.json and then use globally installed inp-client.
- In the target project (where the new version will be tested/used)
npm remove inp-client
- In the inp-client project
npm run update:local
which usesnpm link
andnpm unlink
to update inp-client global installation without publishing inp-client to npm registry.