open-wc/docs/guide/README.md

Introduction

The goal of Open Web Components is to empower everyone with a powerful and battle-tested setup for sharing open source web components. We try to achieve this by giving a set of recommendations and defaults on how to facilitate your web component project. Our recommendations include: developing, linting, testing, tooling, demoing, publishing and automating.

Quickstart

This will kickstart a menu guiding you through all available Open Web Components actions.

# in a new or existing folder:
npm init @open-wc
# requires node 10 & npm 6 or higher

Available Recommendations

• IDE
• Developing
• Linting
• Testing
• Building
• Demoing
• Publishing
• Automating

Our Philosophy

You can read all about our motivation and our philosophy here.

FAQ

• FAQ

Example

The Set-Game Example uses all the above recommendations. You can find a published storybook here: https://example-set-game-open-wc.netlify.com/.