valle-element-js

A generator for valle-elements - web components with Polymer 3

Table of contents

• valle-element-js
  • Table of contents
  • How to install and use
  • The generated element
    • Stack / Features:
    • Folders Structure:
    • UI Docs:
  • Development
    • Run the project locally
    • Code Style
  • Versioning
  • Contributing
  • History
  • License

How to install and use

Verify if you have node and yarn installed.

1 - Install Yeoman:

$ yarn global add yo

2 - Install the valle-element-js generator:

$ yarn global add @valle/generator-valle-element-js

3 - Then generate your new element:

$ yo @valle/valle-element-js

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
├── test/
|   ├── index.html
|   └── your-element_test.html
├── .gitignore
├── your-element.js
├── index.html
└── package.json

UI Docs:

Provide by iron-demo-helpers.

Development

Run the project locally

1 - Prepare the environment:

$ yarn global add yo

2 - Clone the project and install the dependencies:

$ git clone https://github.com/valleweb/valle-element-js.git
$ cd valle-element-js
$ yarn

3 - Link the generator locally:

$ npm link

4 - Run the generator:

$ yo

Code Style

Follow the Valle style guide.

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