https://github.com/datadavev/gh-corner
Simple web-component wrapper around https://github.com/tholman/github-corners
https://github.com/datadavev/gh-corner
Last synced: 5 months ago
JSON representation
Simple web-component wrapper around https://github.com/tholman/github-corners
- Host: GitHub
- URL: https://github.com/datadavev/gh-corner
- Owner: datadavev
- License: mit
- Created: 2021-09-22T13:28:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-22T22:49:47.000Z (about 3 years ago)
- Last Synced: 2025-03-28T08:44:17.477Z (about 1 year ago)
- Language: JavaScript
- Size: 1.89 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# \
A simple web-component wrapper around [github-corners](https://github.com/tholman/github-corners).
This component is intended for use in pages that already make use of [lit](https://lit.dev/) though it works fine in
plain pages as well, just with some additional overhead.
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
## Installation
```bash
npm i gh-corner
```
## Usage
```html
import 'gh-corner/gh-corner.js';
```
or using a CDN:
```html
```
## 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`