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. Our recommendations include: developing, linting, testing, tooling, demoing, publishing and automating.

Quickstart

This will bootstrap a vanilla Web Component project based on our latest recommendations.

mkdir my-element
cd my-element
# Default recommendation
npx -p yo -p generator-open-wc -c 'yo open-wc:vanilla'

Available Recommendations

• IDE
• Developing
• Linting
• Testing
• Demos
• Publishing
• Automating

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/.