https://github.com/1-Platform/op-components

One platform component library.
https://github.com/1-Platform/op-components

lit-element lit-html redhat web webcomponents

Last synced: 3 months ago
JSON representation

One platform component library.

• Host: GitHub
• URL: https://github.com/1-Platform/op-components
• Owner: 1-Platform
• License: mit
• Created: 2020-03-04T10:07:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-17T03:48:41.000Z (9 months ago)
• Last Synced: 2024-05-17T04:40:52.636Z (9 months ago)
• Topics: lit-element, lit-html, redhat, web, webcomponents
• Language: TypeScript
• Homepage: https://1-platform.github.io/op-components/
• Size: 24.1 MB
• Stars: 29
• Watchers: 8
• Forks: 18
• Open Issues: 56
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-lit - One Platform Components - Set of web components for Red Hat One Platform. (Component Libraries)
• awesome-web-components - One Platform Components - Set of web components for Red Hat One Platform. (Real World / Component Libraries)

README

        
# Welcome to One Platform Components Library 👋

![Version](https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000)

[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/1-Platform/op-components#readme)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/1-Platform/op-components/graphs/commit-activity)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/1-Platform/op-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/1-Platform/op-components/alerts/)

One platform component library.

## Install dependencies

```sh

npm install

```

## Usage

### Development server

- Run a single component

```sh

npm run dev 

```

- Build a single component

```sh

npm run build 

```

## Run tests

```sh

npm run build

npm run test

```

### To publish packages to npmjs refer the following links.

- https://docs.npmjs.com/creating-and-publishing-scoped-public-packages

- https://docs.npmjs.com/cli/v6/commands/npm-publish

## Create a new component

### Install packages

```bash

npm install

```

### Create new component

```bash

npm run new

```

#### This would run the generator and add the component to packages folder

#### Run your component

```bash

npm run dev 

```

## 🤝 Contributors

👤 **Ghanshyam Lohar** [@ghanlohar](https://github.com/ghanlohar)

👤 **Diwanshi Gadgil** [@diwanshi](https://github.com/diwanshi)

👤 **Anjnee K. Sharma** [@anjneeksharma](https://github.com/anjneeksharma)

👤 **Sumeet Ingole** [@gisumit](https://github.com/gisumit)

👤 **Deepesh Nair** [@hybridx](https://github.com/hybridx)

👤 **Rigin Oommen** [@riginoommen](https://github.com/riginoommen)