Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muxy/extensions-js
An Easier way to build Twitch Extensions using this JavaScript library for interfacing with Muxy's extensions backend.
https://github.com/muxy/extensions-js
extension library muxy twitch twitch-extensions
Last synced: 3 months ago
JSON representation
An Easier way to build Twitch Extensions using this JavaScript library for interfacing with Muxy's extensions backend.
- Host: GitHub
- URL: https://github.com/muxy/extensions-js
- Owner: muxy
- License: isc
- Created: 2017-07-25T16:40:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T01:22:48.000Z (over 1 year ago)
- Last Synced: 2024-07-08T19:35:58.760Z (4 months ago)
- Topics: extension, library, muxy, twitch, twitch-extensions
- Language: TypeScript
- Homepage: https://dev.muxy.io
- Size: 1.17 MB
- Stars: 28
- Watchers: 7
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-twitch-dev - muxy/extensions-js - Easy way to build Twitch Extensions using this JavaScript library for interfacing with Muxy's extensions backend. (Libraries / JavaScript (Twitch Extensions))
README
# Muxy MEDKit JS Library
The Muxy MEDKit JS library provides easy access to Muxy's powerful extension backend architecture.
The library provides four main sections of functionality: Persistent Data Storage, an Event Manager,
a Twitch Client and a Google Analytics system.
## Hosted Versions
Tagged releases (starting with 2.0.0):
* https://unpkg.com/@muxy/[email protected]/dist/medkit.umd.js
* https://unpkg.com/@muxy/[email protected]/dist/medkit.esm.js
Latest production release:
* https://unpkg.com/@muxy/extensions-js/dist/medkit.umd.js
* https://unpkg.com/@muxy/extensions-js/dist/medkit.esm.js
## Building
To build a production release of the library, simply run:
```sh
npm install
npm run build
```
in this directory. The complete library will be built and both UMD and ES Module versions will be
placed in the `dist/` folder.
- `dist/medkit.umd.js`
- `dist/medkit.esm.js`
## Running Tests
To run the full suite of tests, run:
```sh
npm run test
```
This will fully compile the library and execute all unit tests, printing the results to the console.
Note that this can take several minutes to execute, especially the first time.
## Getting Started
To get started building an extension with Muxy, we have a [Vue.js](https://vuejs.org) based starter
[here](https://github.com/muxy/medkit-starter-vue).
Once you've played around there and are ready to dig into some documentation, our
[Getting Started](https://docs.muxy.io/docs/getting-started-with-medkit) and
[Detailed API Guides](https://docs.muxy.io/reference/medkit-rest-api) should help.