generator-polymer-init-magic-element

A generator for magic web components using Polymer 3

Table of contents

• generator-polymer-init-magic-element
  • Table of contents
  • How to install and use
  • The generated element - Stack / Features: - Folders Structure: - UI Docs:
  • Development - Run the project locally
  • Versioning
  • Contributing
  • History
  • License

How to install and use

Verify if you have node and yarn installed.

1 - Install Polymer CLI:

$ yarn global add polymer-cli

2 - Install the magic-element generator:

$ yarn global add generator-polymer-init-magic-element

3 - Then generate your new element:

$ polymer init

The generated element

Stack / Features:

• Polymer 3.x
• Yarn for dependencies
• Provide UI docs
• Docs for all
• Styling API with custom properties
• more...

Folders Structure:

.
├── README.md
├── CONTRIBUTING.md
├── LICENSE.md
├── demo/
|   └── index.html
├── .gitignore
├── you-element.js
├── index.html
├── index.js
└── package.json

UI Docs:

Provide by iron-demo-helpers.

Development

Run the project locally

1 - Prepare the environment:

$ yarn global add polymer-cli

2 - Clone the project and install the dependencies:

$ git clone https://github.com/magic-components/generator-polymer-init-magic-element.git
$ cd generator-polymer-init-magic-element
$ yarn

3 - Link the generator locally:

$ npm link

4 - Run the generator:

$ polymer init

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our issues the next steps of the project ;) Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT © Larissa Abreu