/element-boilerplate

Fork this repo if you want to start your own Web Component using Polymer

Primary LanguageJavaScript

<my-element>

TODO: Write a project description

Demo

Check it live!

Usage

  1. Install the component using Bower:

    $ bower install my-element --save
  2. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  3. Import Custom Element:

    <link rel="import" href="bower_components/my-element/dist/my-element.html">
  4. Start using it!

    <my-element></my-element>

Options

Attribute Options Default Description
name string World Lorem ipsum

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  1. Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  2. Install local dependencies:

    $ bower install && npm install
  3. To test your project, run a local server and open http://localhost:8000.

    $ grunt
  4. Once you finish developing it, build the distribution files and publish it on Bower.

    $ grunt build
    $ bower register my-element https://github.com/you/my-element

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License