mirror of
https://github.com/jlengrand/open-wc.git
synced 2026-03-10 08:31:19 +00:00
committed by
Thomas Allmer
parent
89819e02ee
commit
0fa9e176ee
10
README.md
10
README.md
@@ -1,6 +1,6 @@
|
||||
# Open Web Component Recommendations
|
||||
|
||||
We want to provide a good set of default on how to vasilitate your web component.
|
||||
We want to provide a good set of default on how to facilitate your web component.
|
||||
|
||||
[](https://circleci.com/gh/open-wc/open-wc)
|
||||
[](https://www.browserstack.com/automate/public-build/M2UrSFVRang2OWNuZXlWSlhVc3FUVlJtTDkxMnp6eGFDb2pNakl4bGxnbz0tLUE5RjhCU0NUT1ZWa0NuQ3MySFFWWnc9PQ==--86f7fac07cdbd01dd2b26ae84dc6c8ca49e45b50)
|
||||
@@ -10,15 +10,15 @@ We want to provide a good set of default on how to vasilitate your web component
|
||||
```bash
|
||||
mkdir my-element
|
||||
cd my-element
|
||||
# Default Recommodation
|
||||
# Default recommendation
|
||||
npx -p yo -p generator-open-wc -c 'yo open-wc:vanilla'
|
||||
```
|
||||
|
||||
## Default Recommodation Content
|
||||
## Default Recommendation Content
|
||||
|
||||
You can also pick and choose to apply them at any point later.
|
||||
|
||||
- Vanilla Webcomponent `npx -p yo -p generator-open-wc -c 'yo open-wc:vanilla-bare'`
|
||||
- Vanilla Web Component `npx -p yo -p generator-open-wc -c 'yo open-wc:vanilla-bare'`
|
||||
- Testing Helpers `npx -p yo -p generator-open-wc -c 'yo open-wc:testing-bare'`
|
||||
- Automated Testing with [Karma](https://karma-runner.github.io/) `npx -p yo -p generator-open-wc -c 'yo open-wc:testing-karma'`
|
||||
- Automated Testing via Karma and [Browserstack](https://www.browserstack.com/) `npx -p yo -p generator-open-wc -c 'yo open-wc:testing-karma-bs'`
|
||||
@@ -26,7 +26,7 @@ You can also pick and choose to apply them at any point later.
|
||||
- Publish with [Storybook](https://storybook.js.org/) `npx -p yo -p generator-open-wc -c 'yo open-wc:publish-storybook'`
|
||||
- Continous Integration with [CircleCi](https://circleci.com/) `npx -p yo -p generator-open-wc -c 'yo open-wc:publish-storybook'`
|
||||
|
||||
## Additional Recommodation
|
||||
## Additional Recommendation
|
||||
|
||||
- Instant Testing in IDE with [Wallaby](https://wallabyjs.com/) `npx -p yo -p generator-open-wc -c 'yo open-wc:testing-wallaby'`
|
||||
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
// .vuepress/config.js
|
||||
module.exports = {
|
||||
title: 'open-wc',
|
||||
description: 'Open Web Components Recommedations',
|
||||
description: 'Open Web Components Recommendations',
|
||||
themeConfig: {
|
||||
displayAllHeaders: false,
|
||||
sidebarDepth: 2,
|
||||
sidebar: [
|
||||
'/guide/',
|
||||
'/recommodations/ide',
|
||||
'/recommodations/linting',
|
||||
'/recommodations/testing',
|
||||
'/recommodations/demos',
|
||||
'/recommodations/publishing',
|
||||
'/recommodations/automate',
|
||||
'/recommendations/ide',
|
||||
'/recommendations/linting',
|
||||
'/recommendations/testing',
|
||||
'/recommendations/demos',
|
||||
'/recommendations/publishing',
|
||||
'/recommendations/automate',
|
||||
'/help/js',
|
||||
],
|
||||
nav: [
|
||||
@@ -22,7 +22,7 @@ module.exports = {
|
||||
repo: 'open-wc/open-wc',
|
||||
docsDir: 'docs',
|
||||
editLinks: true,
|
||||
editLinkText: 'Improve these recommodations (or add your own)',
|
||||
editLinkText: 'Improve these recommendations (or add your own)',
|
||||
lastUpdated: 'Last Updated',
|
||||
},
|
||||
dest: '_site'
|
||||
|
||||
@@ -7,8 +7,8 @@ features:
|
||||
- title: Provides Smart Defaults
|
||||
details: Enjoy the piece of mind that there is a default solution for almost everything. From linting to testing to demos to publishing - have the full experience.
|
||||
- title: Awesome Generators
|
||||
details: Have a quick start or adding an optional recommodation later. With a fleet of generators we got you covered.
|
||||
details: Have a quick start or adding an optional recommendation later. With a fleet of generators we got you covered.
|
||||
- title: Open Source Love
|
||||
details: It's an community driven recommodation (independent of any framework) using mostly tools/services which are free for open source projects.
|
||||
details: It's a community driven recommendation (independent of any framework) using mostly open source tools/services.
|
||||
footer: MIT Licensed | Copyright © 2018-present open-wc
|
||||
---
|
||||
@@ -1,25 +1,25 @@
|
||||
# Introduction
|
||||
|
||||
Open Webcomponents goal is it to allow everyone to have a powerful setup for sharing open source web components. To archive this we give a set of recommodations on howto facilitate such a component.
|
||||
The goal of Open Web Components is to allow everyone to have a powerful setup for sharing open source web components. To achieve this we give a set of recommendations on how to facilitate such a component.
|
||||
|
||||
## Quickstart
|
||||
|
||||
This will setup a vanilla web component basend on our latest recommodations.
|
||||
This will setup a vanilla web component based on our latest recommendations.
|
||||
|
||||
```bash
|
||||
mkdir my-element
|
||||
cd my-element
|
||||
# Default Recommodation
|
||||
# Default recommendation
|
||||
npx -p yo -p generator-open-wc -c 'yo open-wc:vanilla'
|
||||
```
|
||||
|
||||
## Available Recommodations
|
||||
- [IDE](/recommodations/ide.html)
|
||||
- [Linting](/recommodations/linting.html)
|
||||
- [Testing](/recommodations/testing.html)
|
||||
- [Demos](/recommodations/demos.html)
|
||||
- [Publishing](/recommodations/publishing.html)
|
||||
- [Automate](/recommodations/automate.html)
|
||||
## Available Recommendations
|
||||
- [IDE](/recommendations/ide.html)
|
||||
- [Linting](/recommendations/linting.html)
|
||||
- [Testing](/recommendations/testing.html)
|
||||
- [Demos](/recommendations/demos.html)
|
||||
- [Publishing](/recommendations/publishing.html)
|
||||
- [Automate](/recommendations/automate.html)
|
||||
|
||||
## General Help Section
|
||||
- [JavaScript](/help/js.html)
|
||||
@@ -4,13 +4,13 @@ Your IDE is your primary tool while working with code.
|
||||
|
||||
## Visual Studio Code
|
||||
|
||||
We recommond [VSCode](https://code.visualstudio.com/).
|
||||
We recommend [VSCode](https://code.visualstudio.com/).
|
||||
|
||||
For Setup pls visit its [homepage](https://code.visualstudio.com/) and follow installation instructions there.
|
||||
For Setup please visit its [homepage](https://code.visualstudio.com/) and follow installation instructions there.
|
||||
|
||||
## Configuration
|
||||
|
||||
We recommond the following user settings:
|
||||
We recommend the following user settings:
|
||||
```json
|
||||
{
|
||||
"workbench.colorTheme": "Solarized Light",
|
||||
@@ -22,7 +22,7 @@ We recommond the following user settings:
|
||||
},
|
||||
}
|
||||
```
|
||||
**How to set it**:
|
||||
**How to set up**:
|
||||
1. File > Preferences > Settings
|
||||
1. click on "..." > Open settings.json
|
||||
|
||||
@@ -33,7 +33,7 @@ We recommond the following user settings:
|
||||
We recommend the following plugins:
|
||||
|
||||
* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||
Get ESLint feedback directly in your IDE => more details under [Linting](./recommodations/linting)
|
||||
Get ESLint feedback directly in your IDE => more details under [Linting](./recommendations/linting)
|
||||
* [es6-string-html](https://marketplace.visualstudio.com/items?itemName=Tobermory.es6-string-html)
|
||||
Highlights all your html tagged template literal
|
||||
* [es6-string-css](https://marketplace.visualstudio.com/items?itemName=bashmish.es6-string-css)
|
||||
|
Before Width: | Height: | Size: 212 KiB After Width: | Height: | Size: 212 KiB |
@@ -12,7 +12,7 @@ npx -p yo -p generator-open-wc -c 'yo open-wc:lint-eslint'
|
||||
```
|
||||
|
||||
::: tip Info
|
||||
This is part of the default recommodations
|
||||
This is part of the default recommendations
|
||||
:::
|
||||
|
||||
### What you get
|
||||
@@ -3,7 +3,7 @@
|
||||
Having tests should be the fundament of every production ready product.
|
||||
|
||||
## Bare Testing Setup
|
||||
We recommend using [BDD](https://en.wikipedia.org/wiki/Behavior-driven_development)(Behavior Driven Development) as it seem to be easier when talking to non tech collegues. However note that this can still be a personal preference - we give this recommodation to promote unity within everyone using this recommodation.
|
||||
We recommend using [BDD](https://en.wikipedia.org/wiki/Behavior-driven_development)(Behavior Driven Development) as it seem to be easier when talking to non tech collegues. However note that this can still be a personal preference - we give this recommendation to promote unity within everyone using this recommendation.
|
||||
|
||||
Using:
|
||||
- System via [mocha](https://mochajs.org/)
|
||||
@@ -16,7 +16,7 @@ npx -p yo -p generator-open-wc -c 'yo open-wc:testing-bare'
|
||||
```
|
||||
|
||||
::: tip Info
|
||||
This is part of the default recommodations
|
||||
This is part of the default recommendations
|
||||
:::
|
||||
|
||||
### Usage
|
||||
@@ -120,7 +120,7 @@ npx -p yo -p generator-open-wc -c 'yo open-wc:testing-karma'
|
||||
```
|
||||
|
||||
::: tip Info
|
||||
This is part of the default recommodations
|
||||
This is part of the default recommendations
|
||||
:::
|
||||
|
||||
### Usage
|
||||
@@ -146,7 +146,7 @@ npx -p yo -p generator-open-wc -c 'yo open-wc:testing-karma-bs'
|
||||
```
|
||||
|
||||
::: tip Info
|
||||
This is part of the default recommodations
|
||||
This is part of the default recommendations
|
||||
:::
|
||||
|
||||
### Usage
|
||||
Reference in New Issue
Block a user