mirror of
https://github.com/jlengrand/open-wc.git
synced 2026-03-10 08:31:19 +00:00
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# 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.
|
|
|
|
```bash
|
|
mkdir my-element
|
|
cd my-element
|
|
# Default recommendation
|
|
npx -p yo -p generator-open-wc -c 'yo open-wc:vanilla'
|
|
```
|
|
|
|
## Available Recommendations
|
|
- [IDE](/guide/ide.html)
|
|
- [Developing](/guide/developing.html)
|
|
- [Linting](/guide/linting.html)
|
|
- [Testing](/guide/testing.html)
|
|
- [Demos](/guide/demos-storybook.html)
|
|
- [Publishing](/guide/publishing.html)
|
|
- [Automating](/guide/automating.html)
|
|
|
|
## FAQ
|
|
- [FAQ](/faq/)
|
|
|
|
## Example
|
|
The [Set-Game Example](https://github.com/open-wc/example-vanilla-set-game/) uses all the above recommendations.
|
|
You can find a published storybook here: [https://example-set-game-open-wc.netlify.com/](https://example-set-game-open-wc.netlify.com/).
|