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 1 month 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 (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-07-07T21:59:16.000Z (over 9 years ago)
• Last Synced: 2024-09-26T17:08:16.410Z (about 2 months ago)
• Language: HTML
• Homepage:
• Size: 906 KB
• Stars: 369
• Watchers: 34
• Forks: 218
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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)