A web component to display information about a specific repo
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
Install the component using Bower:
$ bower install github-repo --save
Or download as ZIP.
-
Import github-repo Element:
<link rel="import" href="bower_components/github-repo/github-repo.html">
-
Start using it!
<github-repo user="twbs" repo="bootstrap"></github-repo>
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
-
$ [sudo] npm install -g bower polyserve
-
Install local dependencies:
$ bower install
-
To test your project, start the development server
$ polyserve
Once running, you can preview your element at
http://localhost:8080/components/github-repo/
, where github-repo
is the name of the directory containing it.
Simply navigate to the /test
directory of your element to run its tests. If
you are using Polyserve: http://localhost:8080/components/github-repo/test/
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
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.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D