https://github.com/manufosela/circle-values

Web component to draw a circle width related diferent values
https://github.com/manufosela/circle-values

Last synced: 4 days ago
JSON representation

Web component to draw a circle width related diferent values

• Host: GitHub
• URL: https://github.com/manufosela/circle-values
• Owner: manufosela
• License: mit
• Created: 2022-08-21T22:29:35.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-08-21T22:44:49.000Z (over 2 years ago)
• Last Synced: 2024-11-10T19:24:23.181Z (2 months ago)
• Language: JavaScript
• Size: 195 KB
• Stars: 0
• Watchers: 2
• 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 circle-values

```

## Usage

```html

  import 'circle-values/circle-values.js';

  

  

  

  [...more circle-values...]

```

## Example

Codepen Example link [here](https://codepen.io/manufosela/pen/bGvZEgj).

## Linting and formatting

To scan the project for linting and formatting errors, run

```bash

npm run lint

```

To automatically fix linting and formatting errors, run

```bash

npm run format

```

## 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 `demo/index.html`