arikimolloy / open-wc

We want to provide a good set of default on how to facilitate your web component.

🛠 Status: In Development

open-wc is still in an early stage - please review our recommendations and test our tools! We'd love to get your feedback.

Open Web Component Recommendations

Open Web Components provides a set of defaults, recommendations and tools to help facilitate your web component project. Our recommendations include: developing, linting, testing, building, tooling, demoing, publishing and automating.

Usage

npm i -g yo
npm i -g generator-open-wc

# scaffold a complete new component
mkdir my-element
cd my-element
# Default development recommendation
yo open-wc:scaffold-vanilla

# upgrade/align your existing web component with 'open-wc' recommendations
cd existing-web-component
yo open-wc

Homepage

For more details please visit us at open-wc.org.

Contact

Feel free to create a github issue for any feedback or questions you might have.

You can also find us on the Polymer slack in the #open-wc channel.

You can join the Polymer slack by visiting this link.

We Proudly Use

Guide

# bootstrap/setup
npm run bootstrap

# linting
npm run lint

# local testing
npm run test

# testing via browserstack
npm run test:bs

# run commands only for a specific scope
lerna run <command> --scope @open-wc/<package-name> --stream