mozilla-rally / rally-sdk

This is the Rally partner support library, `rally.js`, used to manage the lifecycle of Rally studies.

@mozilla/rally-sdk

This is the Rally partner support library, used to manage the lifecycle of Rally studies.

This library is used in the Rally Study Template.

TypeScript vs. JS

This project is written in TypeScript, which you may use directly from your TypeScript code, or you may use the TypeScript compiler to build rally.js.

Building rally.js

First, install dependencies:

npm install

Then, build rally.js:

npm run build

Manual testing using npm link

Manual testing can be done as follows:

1. Run npm link in this directory (rally-sdk)
2. In the directory of the testing grounds (e.g. the study-template), run npm link "@mozilla/rally-sdk". This will make the test project use the local version of @mozilla/rally-sdk, automatically tracking any change to it.

And to undo the linking:

3. Run npm unlink "@mozilla/rally-sdk" in the testing directory.
4. Run npm unlink in the support/ directory.