https://github.com/manufosela/animation-snow
Lit-Element web-component to snow the screen
https://github.com/manufosela/animation-snow
Last synced: 4 months ago
JSON representation
Lit-Element web-component to snow the screen
- Host: GitHub
- URL: https://github.com/manufosela/animation-snow
- Owner: manufosela
- License: mit
- Created: 2021-01-10T01:35:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-10T01:45:51.000Z (over 4 years ago)
- Last Synced: 2025-01-08T06:16:41.374Z (5 months ago)
- Language: JavaScript
- Size: 145 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# \ [](https://www.npmjs.com/package/animation-snow) [](https://github.com/manu/animation-snow) [](https://codepen.io/manufosela/pen/oNzMrXW)
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i animation-snow
```
## Usage
```html
import 'animation-snow/animation-snow.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`