Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/epa-wg/custom-element-test
test and storybook for @epa-wg/custom-element
https://github.com/epa-wg/custom-element-test
customelement webcomponent
Last synced: about 1 month ago
JSON representation
test and storybook for @epa-wg/custom-element
- Host: GitHub
- URL: https://github.com/epa-wg/custom-element-test
- Owner: EPA-WG
- License: apache-2.0
- Created: 2022-11-30T06:50:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T05:37:31.000Z (6 months ago)
- Last Synced: 2024-09-26T21:22:31.014Z (about 2 months ago)
- Topics: customelement, webcomponent
- Language: HTML
- Homepage:
- Size: 4.64 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Project is deprecated in favor
@epa-wg/custom-element-dist
# custom-element-test
test and storybook for [@epa-wg/custom-element](https://github.com/EPA-WG/custom-element)
[![git][github-image] GitHub][git-url]
| Live demo: [custom-element][demo-url]
| [StoryBook][storybook-url]
| [![coverage][coverage-image]][coverage-url]
## Installation
```bash
npm i
```
### local development
1. in working folder, a root for `custom-element-test` and `custom-element`
```bash
git clone [email protected]:EPA-WG/custom-element.git
cd custom-element
npm i
npm link
cd ../custom-element-test
npm i
npm link @epa-wg/custom-element
bash bash bin/postinstall.sh
```
## 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 minimize 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 `src/demo/index.html`
[git-url]: https://github.com/EPA-WG/custom-element
[github-image]: https://cdnjs.cloudflare.com/ajax/libs/octicons/8.5.0/svg/mark-github.svg
[demo-url]: https://unpkg.com/@epa-wg/[email protected]/dist/index.html
[storybook-url]: https://unpkg.com/@epa-wg/[email protected]/storybook-static/index.html?path=/story/welcome--introduction
[coverage-image]: https://unpkg.com/@epa-wg/[email protected]/coverage/coverage.svg
[coverage-url]: https://unpkg.com/@epa-wg/[email protected]/coverage/lcov-report/index.html