https://github.com/googlearchive/seed-element
Polymer element boilerplate
https://github.com/googlearchive/seed-element
Last synced: 11 months ago
JSON representation
Polymer element boilerplate
- Host: GitHub
- URL: https://github.com/googlearchive/seed-element
- Owner: googlearchive
- Archived: true
- Created: 2014-04-03T02:06:48.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-01-25T21:55:54.000Z (about 9 years ago)
- Last Synced: 2025-04-12T06:38:37.325Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 1.52 MB
- Stars: 276
- Watchers: 49
- Forks: 77
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
- awesome-projects-boilerplates - Polymer Seed Element
README
# seed-element
An element providing a starting point for your own reusable Polymer elements.
## Dependencies
Element dependencies are managed via [Bower](http://bower.io/). You can
install that via:
npm install -g bower
Then, go ahead and download the element's dependencies:
bower install
## Linting Your Element
If you wish to lint your element, we recommend that you use
[Polylint](https://github.com/PolymerLabs/polylint) to take into account Polymer
linting specificities. You can install it via:
npm install -g polylint
And you can run it via:
polylint -i seed-element.html
If your element contains errors, they will appear on the console.
Note that it is possible to use `Polylint` with Atom and Sublime with the appropriate package/plugin.
For more options regarding `polylint`, please refer to the
[documentation](https://github.com/PolymerLabs/polylint#polylint).
## Playing With Your Element
If you wish to work on your element in isolation, we recommend that you use
[Polyserve](https://github.com/PolymerLabs/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/seed-element/`, where `seed-element` 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/seed-element/test/`
### web-component-tester
The tests are compatible with [web-component-tester](https://github.com/Polymer/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 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.
## Yeoman support
If you'd like to use Yeoman to scaffold your element that's possible. The official [`generator-polymer`](https://github.com/yeoman/generator-polymer) generator has a [`seed`](https://github.com/yeoman/generator-polymer#seed) subgenerator.