@step-mobile/sdk

Step SDK

This SDK contains code and logic for authenticating and communicating with the Step API.

Getting Started

yarn install

Running TypeScript compiler and linter

yarn lint

Running integration tests locally

First, make sure you have the various services running locally, by following Server Readme - Running Services.

Then, you can run local integration tests with:

yarn test:local

Running integration tests against dev environment

yarn test:dev

Publishing

You should always run generate command first to make sure the SDK is up to date with Swagger

yarn generate

Next, lint and build the source code by running the lint command, this updates the dist directory that will be published to npm:

yarn lint

To publish, simply run yarn publish.

If you do not have access, you can request access from [e-mail]

Adding New Service

In order for a new service to become available in the SDK, you need to edit bin/generate-api.js file and add it to the list of services the script monitors, run yarn generate to generate service stubs and publish a new version.