https://github.com/kaltura/playkit-js-ivq
https://github.com/kaltura/playkit-js-ivq
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kaltura/playkit-js-ivq
- Owner: kaltura
- License: agpl-3.0
- Created: 2019-03-10T13:32:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-18T11:02:49.000Z (4 months ago)
- Last Synced: 2025-06-18T12:20:46.657Z (4 months ago)
- Language: TypeScript
- Size: 8.33 MB
- Stars: 2
- Watchers: 21
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PlayKit JS IVQ - Quiz plugin for the [PlayKit JS Player]
[](https://github.com/kaltura/playkit-js-ivq/actions/workflows/run_canary_full_flow.yaml)
[](https://github.com/prettier/prettier)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-ivq)
[](https://www.npmjs.com/package/@playkit-js/playkit-js-ivq/v/canary)
PlayKit JS IVQ 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
### Prerequisites
The plugin requires [Kaltura Player] to be loaded first.
[kaltura player]: https://github.com/kaltura/kaltura-player-js
### Installing
First, clone and run [yarn] to install dependencies:
[yarn]: https://yarnpkg.com/lang/en/
```
git clone https://github.com/kaltura/playkit-js-ivq.git
cd playkit-js-ivq
yarn install
```
### Building
Then, build the plugin
```javascript
yarn run build
```
### Testing
The plugin uses `cypress` tool for e2e tests
```javascript
yarn run test
```
UI conf file (`cypress/public/ui-conf.js`) contains Kaltura player and plugin dependencies.
Keep Kaltura player and dependency versinos aligned to currently released versions.
### Embed the library in your test page
Finally, add the bundle as a script tag in your page, and initialize the player
```html
var playerContainer = document.querySelector("#player-placeholder");
var config = {
...
targetId: 'player-placeholder',
plugins: {
ivq: { ... },
timeline: { ... },
kalturaCuepoints: { ... },
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia(...);
```
## Documentation
IVQ plugin dependencies can been found here:
- **[Dependencies](#dependencies)**
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-ivq/tags).
## License
This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details
Plugin dependencies:
Cue Points
Timeline