https://github.com/pickra/open-wc
https://github.com/pickra/open-wc
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pickra/open-wc
- Owner: Pickra
- License: mit
- Created: 2022-08-16T21:18:16.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-16T21:18:42.000Z (almost 4 years ago)
- Last Synced: 2025-07-16T07:12:16.697Z (12 months ago)
- Language: TypeScript
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# \
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i open-wc
```
## Usage
```html
import 'open-wc/open-wc.js';
```
## Testing with Web Test Runner
To execute a single test run:
```bash
npm run test
```
To run the tests in interactive watch mode run:
```bash
npm run test:watch
```
## Demoing with Storybook
To run a local instance of Storybook for your component, run
```bash
npm run storybook
```
To build a production version of Storybook, run
```bash
npm run storybook:build
```
## Tooling configs
For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
## Local Demo with `web-dev-server`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`