Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webcomponents/polymer-boilerplate
Fork this repo if you want to start your own Web Component using Polymer
https://github.com/webcomponents/polymer-boilerplate
Last synced: about 2 months ago
JSON representation
Fork this repo if you want to start your own Web Component using Polymer
- Host: GitHub
- URL: https://github.com/webcomponents/polymer-boilerplate
- Owner: webcomponents
- Archived: true
- Created: 2013-08-19T13:56:42.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-07T21:59:16.000Z (almost 9 years ago)
- Last Synced: 2024-04-13T03:38:53.574Z (2 months ago)
- Language: HTML
- Homepage:
- Size: 906 KB
- Stars: 369
- Watchers: 34
- Forks: 225
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Lists
- awesome-polymer - Polymer boilerplate
- awesome-webcomponents - Using Polymer
- awesome-custom-elements - Using Polymer
- awesome-stars - polymer-boilerplate - Fork this repo if you want to start your own Web Component using Polymer (HTML)
- awesome-stars - webcomponents/polymer-boilerplate - Fork this repo if you want to start your own Web Component using Polymer (HTML)
README
# <my-repo>
> A bare minimum custom element starter-kit using [Polymer](http://www.polymer-project.org/).
>
> Like [Yeoman](http://yeoman.io/)? Use the [generator-element](https://www.npmjs.org/package/generator-element) instead.
>
> Looking for a working example? Check [hello-world-polymer](https://github.com/webcomponents/hello-world-polymer).
## Demo
[Check it live!](http://my-user.github.io/my-repo)
## Install
Install the component using [Bower](http://bower.io/):
```sh
$ bower install my-repo --save
```
Or [download as ZIP](https://github.com/my-user/my-repo/archive/master.zip).
## Usage
1. Import polyfill:
```html
```
2. Import custom element:
```html
```
3. Start using it!
```html
```
## Options
Attribute | Options | Default | Description
--- | --- | --- | ---
`foo` | *string* | `bar` | Lorem ipsum dolor.
## Methods
Method | Parameters | Returns | Description
--- | --- | --- | ---
`unicorn()` | None. | Nothing. | Magic stuff appears.
## Events
Event | Description
--- | ---
`onsomething` | Triggers when something happens.
## Development
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
1. Install [bower](http://bower.io/) & [polyserve](https://npmjs.com/polyserve):
```sh
$ npm install -g bower polyserve
```
2. Install local dependencies:
```sh
$ bower install
```
3. Start development server and open `http://localhost:8080/components/my-repo/`.
```sh
$ polyserve
```
## History
For detailed changelog, check [Releases](https://github.com/my-user/my-repo/releases).
## License
[MIT License](http://opensource.org/licenses/MIT)