An Easier way to build Twitch Extensions using this JavaScript library for interfacing with Muxy's extensions backend.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets/images Inital release Aug 31, 2017
certs Inital release Aug 31, 2017
docs/template Version 1.0.3 Sep 21, 2017
libs Version 1.0.3 Sep 21, 2017
manual Version 1.0.4 Oct 11, 2017
spec Version 1.0.4 Oct 11, 2017
src Version 1.1.0 May 3, 2018
.babelrc Version 1.0.3 Sep 21, 2017
.editorconfig Inital release Aug 31, 2017
.esdoc.json Version 1.0.4 Oct 11, 2017
.eslintignore Inital release Aug 31, 2017
.eslintrc.js Version 1.0.3 Sep 21, 2017
.gitignore Version 1.0.6 Jan 6, 2018
.npmignore Version 1.0.4 Oct 11, 2017
.prettier.config.js Version 1.0.3 Sep 21, 2017
CHANGELOG.md Version 1.1.0 May 3, 2018
LICENSE Inital release Aug 31, 2017
README.md Version 1.0.4 Oct 11, 2017
karma.conf.js Version 1.0.3 Sep 21, 2017
package.json Version 1.1.0 May 3, 2018
webpack.config.js Version 1.0.3 Sep 21, 2017

README.md

Muxy Extension JS Library

The Muxy Extensions JS library provides easy access to Muxy's powerful backend architecture.

The extension provides four main sections of functionality: Data Storage, an Event Manager, a Twitch Client and a Google Analytics system.

Hosted Versions

Muxy hosts specific versions and latest releases at https://ext-cdn.muxy.io/muxy-extensions-js.

Tagged releases (starting with 1.0.0):

Latest production release:

Building

To build a production release of the library, simply run:

npm install
npm run build

in this directory. The complete library will be built and both minified and full versions will be placed in the dist/ folder.

  • dist/muxy-extensions.js
  • dist/muxy-extensions.min.js

Running tests

To run the full suite of tests, run:

npm run test

This will fully compile the SDK and execute all unit tests, printing the results to the console. Note that this can take several minutes to execute, especially the first time.

Building documentation

A hosted version of the documentation in this repo can be found at https://dev.muxy.io/javascript/index.html.

The SDK documentation can be build locally by running:

npm run docs

This will generate a full suite of HTML-formatted documentation in the dist/docs/ directory. The main entry to the docs is at dist/docs/index.html