https://github.com/manufosela/starry-sky

Starry Sky web component
https://github.com/manufosela/starry-sky

Last synced: about 1 month ago
JSON representation

Starry Sky web component

• Host: GitHub
• URL: https://github.com/manufosela/starry-sky
• Owner: manufosela
• License: mit
• Created: 2023-12-08T14:04:45.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-09T09:38:03.000Z (about 1 year ago)
• Last Synced: 2023-12-10T09:25:23.924Z (about 1 year ago)
• Language: JavaScript
• Size: 91.8 KB
• Stars: 0
• Watchers: 1
• 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 starry-sky

```

## Usage

```html

  import 'starry-sky/starry-sky.js';

```

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

```

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