Skip to content

Latest commit

 

History

History
91 lines (70 loc) · 1.75 KB

README.md

File metadata and controls

91 lines (70 loc) · 1.75 KB
Raw

<epiviz-finding>

Web component to store insights when exploring genomic data.

findings

TODO:

  • Update README
  • Update Storybook
  • Tests
  • Documentation
  • custom elements specification

This webcomponent follows the open-wc recommendation.

Installation

npm i epiviz-finding

Usage

<script type="module">
  import 'epiviz-finding/epiviz-finding.js';
</script>

<epiviz-finding></epiviz-finding>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint
npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint
npm run format:prettier

Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

npm run test

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

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

npm start

To run a local development server that serves the basic demo located in demo/index.html