Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manufosela/stars-rating
A stars' images filled to show a rate
https://github.com/manufosela/stars-rating
Last synced: about 1 month ago
JSON representation
A stars' images filled to show a rate
- Host: GitHub
- URL: https://github.com/manufosela/stars-rating
- Owner: manufosela
- License: mit
- Created: 2016-11-17T22:02:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-08T09:46:19.000Z (10 months ago)
- Last Synced: 2024-11-10T09:19:01.074Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 542 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
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 @manudosela/stars-rating
```## Usage
```html
import 'stars-rating/stars-rating.js';
```
## Styling
- **--star-size**. Default 1em
- **--star-color**. Default #FFD700
- **--star-unicode**. Default'★'
- **--star-reset-unicode**. Default'ø'## 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`