PlayKit JS Related - Related plugin for the [PlayKit JS Player]


PlayKit JS Related is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].

[typescript]: https://www.typescriptlang.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io

Getting Started

$3

The plugin requires [Kaltura Player] and [playkit-ui-managers] to be loaded first.

[kaltura player]: https://github.com/kaltura/kaltura-player-js
[playkit-ui-managers]: https://github.com/kaltura/playkit-js-ui-managers

$3

First, clone and run [yarn] to install dependencies:

[yarn]: https://yarnpkg.com/lang/en/

``
git clone https://github.com/kaltura/playkit-js-related.git
cd playkit-js-related
yarn install
`

$3

Then, build the plugin

`javascript
yarn run build
`

$3

Finally, add the bundle as a script tag in your page, and initialize the player

`html









`

Documentation

- Configuration & API

Running the tests

Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari

[karma]: https://karma-runner.github.io/1.0/index.html

`
yarn run test
`

You can test individual browsers:

`
yarn run test:chrome
yarn run test:firefox
yarn run test:safari
``

$3

We use ESLint recommended set with some additions for enforcing [Flow] types and other rules.

See ESLint config for full configuration.

We also use .editorconfig to maintain consistent coding styles and settings, please make sure you comply with the styling.

Compatibility

TBD

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details