@playkit-js/marketo-events v0.2.6

@playkit-js/marketo-events

@playkit-js/marketo-events is a kaltura player plugin that allows to send player events to marketo.

@playkit-js/marketo-events is written in ECMAScript6 and TypeScript (strongly typed superset of ES6), and transpiled in ECMAScript5 using Babel and the TypeScript compiler.

Webpack is used to build the distro bundle and serve the local development environment.

Features

• Send player events to marketo

Getting started with development

# First, checkout the repository and install the required dependencies
git clone https://github.com/Kaltura-PS/playkit-js-marketo-events.git

# Navigate to the repo dir
cd playkit-js-marketo-events

# Run dev-server for demo page (recompiles on file-watch, and write to actual dist fs artifacts)
npm run dev

# Before submitting a PR - Run the pre commit command
npm run pre:commit

# this command will run:

# 1. types check
# 2. lint check
# 3. generate/update types
# 4. generate/update docs

The dev server will host files on port 8000. Once started, the demo can be found running at http://localhost:8000/.

Before submitting a PR, please see our contribution guidelines.

Linter (ESlint)

Run linter:

npm run lint:check

Run linter with auto-fix mode:

npm run lint:fix

Formatting Code

Run prettier to format code

npm run prettier:fix

Type Check

Run type-check to verify TypeScript types

npm run types:check

Automated tests (Mocha/Karma)

Run all tests at once:

npm test

Run unit tests in watch mode:

npm run test:watch

Design

An overview of this project's design, can be found here.

API docs

API docs

Usage guide

usage guide

Demo

https://kaltura.github.io/playkit-js-marketo-events/demo/index.html

License

playkit-js-marketo-events is released under Apache 2.0 License