Skip to content
This repository has been archived by the owner on Oct 20, 2020. It is now read-only.

Latest commit

 

History

History
105 lines (72 loc) · 3.22 KB

README.md

File metadata and controls

105 lines (72 loc) · 3.22 KB
Raw

streaming-list

Travis Codeclimate note Coverage Bower Published on webcomponents.org

A webcomponent written with Polymer for list Twitch and (in future) Youtube streams. You will be able to filter the results by a specific game and define priority for a selected language.

Example:

<streaming-list lang="pt" game="Dota 2"></streaming-list>

The demo and API is available here.

Browser Compatibility

  • Google Chrome
  • Mozilla Firefox
  • Safari >= 9
  • Microsoft Edge
  • Internet Explorer >= 11

How to use this web-component

$ bower install streaming-list
<!DOCTYPE html>
<html lang="en">
  <head>
    <script src="https://polygit2.appspot.com/components/webcomponentsjs/webcomponents-lite.js"></script>
    <link rel="import" href="bower_components/streaming-list.html">
  </head>
  <body>
    <streaming-list></streaming-list>
  </body>
</html>

Dev Dependencies

Element dependencies are managed via Bower. You can install that via:

npm install -g bower

Then, go ahead and download the element's dependencies:

bower install

Playing With Your Element

If you wish to work on your element in isolation, we recommend that you use Polyserve to keep your element's bower dependencies in line. You can install it via:

npm install -g polyserve

And you can run it via:

polyserve

Once running, you can preview your element at http://localhost:8080/components/streaming-list/, where streaming-list is the name of the directory containing it.

Testing Your Element

Simply navigate to the /test directory of your element to run its tests. If you are using Polyserve: http://localhost:8080/components/streaming-list/test/

web-component-tester

The tests are compatible with web-component-tester. Install it via:

npm install -g web-component-tester

Then, you can run your tests on all of your local browsers via:

wct --skip-plugin sauce

WCT Tips

wct -l chrome will only run tests in chrome.

wct -p will keep the browsers alive after test runs (refresh to re-run).

wct test/some-file.html will test only the files you specify.