valle-element generator

Generator for valle elements using Polymer 2x.

Table of contents

• How to install and use
• The generated element
  • Stack / Features
  • Folders Structure
• Development
  • Run the project locally
  • Code Style
  • Tests
• Versioning
• Contributing
• History
• License

How to install and use

Verify if you have node and yarn installed.

1 - Install bower and Polymer CLI:

$ yarn global add bower
$ yarn global add polymer-cli

2 - Install the valle-element generator:

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

3 - Then generate your new element:

$ polymer init

The generated element

Stack / Features:

• Polymer 2.x
• Bower for dependencies
• Unit tests with Web Component Tester
• Lint with ESlint and Polylint
• CI with travis
• Provide UI docs
• Docs for all
• Styling API with custom properties
• more...

Folders Structure:

.
├── README.md
├── CONTRIBUTING.md
├── LICENSE.md
├── demo/
|   └── index.html
├── test/
|   ├── you-element_test.html
|   └── index.html
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .travis.yml
├── wct.conf.json
├── bower.json
├── polymer.json
├── you-element.html
└── index.html

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/valleweb/generator-polymer-init-valle-element.git
$ cd generator-polymer-init-valle-element
$ yarn

3 - Link the generator locally:

$ npm link

4 - Run the generator:

$ polymer init

Code Style

Follow the Banana NodeJS style guide.

Tests

Run the unit tests with mocha and Validate the code style with ESLint:

$ yarn run test

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 License © valleweb team