open-element-template

---

Delete everything below this line after forking or cloning

About

Much like Polymer boilerplate, Polymer seed-element, generator element, and others, this is a template for starting new projects. Sorry for calling it "template", since that broadly means something else for web components.

So why another template for Polymer elements? This one has two ideas behind it:

1. It makes use of all the services that support open source projects, such as Travis for testing, SauceLabs for cross-browser testing, some badges and other stuff. Figuring out how to setup and integrate these services can take time and isn't fun or productive.
2. If you fork or clone from this repository, you can merge in new services and features into your component as they become available. You don't have to figure it out, just git pull to merge in the new features and you will get anything new that has been added. This can be new features, new documentation, new badges, etc.

Features

• Web Component Testing setup and configuration
• Travis CI configuration file
• SauceLabs integration for multi-browser testing
• Code coverage using Istanbul and Coveralls
• web-components keyword for inclusion on customelements.io
• Nifty badges already included for build status, test coverage, dependency status, and Gitter
• Forking this repo means that as new features are added, they can be included in your project with a simple git pull request

Setup Services

1. Fork this repo
   • Click Fork in the top right-hand corner of this webpage
2. Travis CI
   • Login using Githubaccount by clicking Sign in with GitHub in the top right-hand corner of Travis CI webpage
   • Click + next to Repositories
   • Turn on Travis CI for your fork
3. SauceLabs
   • Create account
   • Add secret keys to .travis.yml by following this link

Things to Try

• npm test -- uses the web component tester to open browsers at SauceLabs and test your element on each of them
• npm run demo -- shows your new element in action
• npm run testdebug -- runs a single test using your local copy of Chrome, and keeps Chrome open so that you can see the debug console and refresh to re-run tests

Updating

Are there new features in this repo that you wish you had? If you forked or cloned from this project, here's how to merge them into your project:

1. cd YourProject -- get ready...
2. git checkout master -- make sure your project is up to date and you are working on the master branch
3. git pull https://github.com/apowers313/<this repo> master -- fetch and merge the latest version of this project into your master branch
4. If necessary, resolve any merge conflicts. For help, check this out https://help.github.com/articles/merging-an-upstream-repository-into-your-fork/
5. git commit -am 'Merged latest version of <this repo>' -- commit merge changes
6. git push origin master -- push the entire project back to GitHub