Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@rubixfunctions/r3x-js-sdk

rubixFunctions4Apache-2.00.0.14TypeScript support: included

SDK to allow for ease of development of a function as a container

readme

RubiX JavaScript SDK

CircleCI npm version License

Getting Started

These steps will get you a clone of the repository, install the dependancies and run the SDK.

$ git clone git@github.com:rubixFunctions/r3x-js-sdk.git
$ npm install
$ npm start

Running Function

For development and testing purposes, a function is available and can be run as a container.

$ docker pull quay.io/rubixfunctions/r3x-js-showcase
$ docker run -t -p 8080:8080 quay.io/rubixfunctions/r3x-js-showcase

Once running POST request to localhost:8080

Documentation

For full information on how to use the SDK and deploy a function to Knative, refer to our Documentation here.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details