sdk-js

This is a lerna-powered mono-repository for Screeb javascript SDKs.

Table of Contents:

• Packages
• Get Started
• Support
• Contributing
• License

Get started

Here is the guide to set everything up before contributing.

Packages

This is a monorepo with multiple packages leveraging lerna:

• @screeb/eslint-config - Screeb's eslint config for frontend app.
• @screeb/template-lib - Screeb's template for a front-end lib.
• @screeb/typescript-config - Screeb's typescript configs for frontend
• @screeb/sdk-browser - Screeb's browser sdk.
• @screeb/sdk-browser-example - Screeb's example app for browser sdk.
• @screeb/sdk-react - Screeb's browser sdk, optimized for React.
• @screeb/sdk-react-example - Screeb's example app for react sdk.
• @screeb/sdk-angular - Screeb's browser sdk, optimized for Angular.
• @screeb/sdk-angular-example - Screeb's example app for angular sdk.

Getting set up

You'll need to have some tools installed locally to build and test action destinations.

• Node 18.12 (latest LTS, we recommand using nvm for managing Node versions)

If you are a Screeb employee you can directly git clone the repository locally. Otherwise you'll want to fork this repository for your organization to submit Pull Requests against the main Screeb repository. Once you've got a fork, you can git clone that locally.

# Clone the repo locally
git clone <your fork or https://github.com/ScreebApp/sdk-js.git>
cd sdk-js

npm login

# Requires node 18.12.1, optionally: nvm use 18.12.1
npm i

# Run unit tests to ensure things are working!
npm test

Support

For any issues, please contact our support team at support@screeb.com.

Contributing

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.

License

Released under MIT License.