An Extension Backend Service that supports the front side of the Interactive Sync, connected to the Twitch API allowing to a viewer to perform chosen actions by developers to use them in Twitch Plays Experiences.
See the Interactive Sync documentation for more details!
Connect on Twitch Developers and register an extension to use ID / Twitch API if you don't have one. Else, go directly to step 4.
- Choose your name and click on "Continue",
- Select these Extension Types: "Panel", "Video Fullscreen" and "Mobile",
- After fill the inputs and create the extension version, click on the button "Extension Settings",
- Note the Client ID of your (new) extension,
- On Twitch API Client Secret, generate a new Client Secret,
- On Extension Client Configuration, get an Extension Secret,
- Save your Client ID / Secret and Extension Secret for the environment variables
Clone the repository on the local folder which will contain your front-end code / the EBS, and install dependencies with yarn install.
Create a .env file with this template:
EXT_CLIENT_ID=YOUR_CLIENT_ID
EXT_CLIENT_SECRET=YOUR_CLIENT_SECRET
EXT_SHARED_SECRET=YOUR_SHARED_SECRET
EXT_HOST=YOUR_HOST
EXT_BLACKLIST_URI=YOUR_BLACKLIST_URI
EXT_HOST must follow this structure - //YOUR_HOST/ - and is to be defined when you deploy the server on the web.
EBS (Extensions Backend Service) must be run and hosted separately.
As you set environment variables, run yarn start to start the node server.
| Command | Description |
|---|---|
yarn install |
Install back-end dependencies |
yarn start |
Run extensions backend service |
yarn start:prod |
Run EBS in the production mode |
yarn test |
Run tests |