Skip to content
StarCraft II Profile Twitch extension - frontend
JavaScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
public
scripts
src
.browserslistrc
.env.sample
.eslintrc.json
.gitignore
.stylelintrc
.travis.yml
LICENSE
README.md
package-lock.json
package.json

README.md

sc2profile-twitch-extension-frontend

Greenkeeper badge Travis Build Status Maintainability Test Coverage

This is an official repository of StarCraft II Profile Twitch Extension.

For current status see the kanban board of the project.

Setup

Install and configure sc2profile-twitch-extension-api first.

To run a local server you need Node.js, preferably LTS version. Once installed, run the following commands:

$ git clone https://github.com/lukemsc/sc2profile-twitch-extension-frontend.git
$ cd sc2profile-twitch-extension-frontend
$ cp .env.sample .env

Fill the .env file with the following information:

  • REACT_APP_SC2PTE_API_URL - extension API URL (default is http://localhost:3000)
  • REACT_APP_UPDATE_INTERVAL - how often the extension will poll for stat updates (in miliseconds) - for testing purposes it is reasonable to keep this value low (e.g. 5000 for 5 seconds)

You can now complete the setup process and run the project locally:

$ npm install
$ HTTPS=true npm start

The project hasn't been set up to work with Twitch Developer Rig yet.

Build

Create .env.production file with environment variables to be used in production environment.

To create a ZIP package suitable for deployment on Twitch.tv follow the steps below:

$ npm run build
$ cd build/
$ zip -r build.zip ./*

Upload the zipped package via Extension Dashboard on Twitch Developers Site.

Contact

See the project homepage for contact information.

License

Code is available under MIT license. See LICENSE for more information.

Graphic assets included in the repository are not subject to the license above.

You can’t perform that action at this time.