https://github.com/manufosela/animation-fireworks

Lit-Element Web-Component to show fireworks animation
https://github.com/manufosela/animation-fireworks

Last synced: 4 days ago
JSON representation

Lit-Element Web-Component to show fireworks animation

• Host: GitHub
• URL: https://github.com/manufosela/animation-fireworks
• Owner: manufosela
• License: mit
• Created: 2021-01-10T22:07:01.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-10T22:08:53.000Z (almost 4 years ago)
• Last Synced: 2024-10-03T02:13:51.350Z (about 1 month ago)
• Language: JavaScript
• Size: 146 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# \ [![npm-package](https://img.shields.io/badge/npmjs-package-red)](https://www.npmjs.com/package/animation-fireworks) [![github](https://img.shields.io/badge/github-repository-green)](https://github.com/manu/animation-fireworks) [![codepen-example](https://img.shields.io/badge/codepen-example-black)](https://codepen.io/manufosela/pen/oNzPYjv)

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

## Installation

```bash

npm i animation-fireworks

```

## Usage

```html

  import 'animation-fireworks/animation-fireworks.js';

```

## Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

```bash

npm run lint

```

You can lint with ESLint and Prettier individually as well

```bash

npm run lint:eslint

```

```bash

npm run lint:prettier

```

To automatically fix many linting errors, run

```bash

npm run format

```

You can format using ESLint and Prettier individually as well

```bash

npm run format:eslint

```

```bash

npm run format:prettier

```

## Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

```bash

npm run test

```

To run the tests in watch mode (for TDD, for example), 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.

## Build dist

```bash

npm run build

```

## 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`