Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.27 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.27 KB

api-sdk-creator-js

Contains libraries to aid SDK developers in the creation of API client SDKs.

See the individual library READMEs for more details. The best starting place is with the http-api-client README

📝 This library is still in active development and may break compatibility in future releases

Development

The repository is managed by Rush. As such, the Rush Command Set needs to be used to add/remove/update packages and to build/publish the modules/libraries that make up the @api-sdk-creator set.

Note: Using rushx is the equivalent to using npm run

Building

$ rush install
$ rush build

Testing

$ rush rebuild
$ cd <project> && rushx test

Publishing

The @api-sdk-creator organisation is hosted on https://registry.npmjs.org/

Rush uses the .npmrc-publish file to read config to access/public the modules to the NPM organisation. After npm login --scope=@api-sdk-creator the access token should be given to rush via the NPM_AUTH_TOKEN env var ie:

$ NPM_AUTH_TOKEN=abc123 rush publish ...