Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.11 KB

README.md

File metadata and controls

57 lines (44 loc) · 1.11 KB

<churrofi-widgets>

This webcomponent follows the open-wc recommendation.

Installation

npm i churrofi-widgets

Usage

<script type="module">
  import 'churrofi-widgets/churrofi-widgets.js';
</script>

<churrofi-widgets></churrofi-widgets>

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

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