open-index/open-npm huggingface dataset:
npm package: @freshworks/react-nucleus
Description: React UI Components for Freshworks
Author: Freshworks
Latest version: 0.3.1

<h1 align="center">react-nucleus</h1>

![Build](https://github.com/freshworksinc/react-nucleus/workflows/Build/badge.svg)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)


[Nucleus](https://react-nucleus.netlify.app/) design system in [React](https://reactjs.org/) based on [Styled Components](https://styled-components.com/)

## Installation

Peer Dependencies to be installed
```
npm install styled-components
```

Install the package with github. Please ensure you are using a proper version tag or commit id.

**Dont' install using the master branch or default url**

```
npm install git+ssh://git@github.com/freshworksinc/react-nucleus.git@0.1.3
```



## Usage

Here is a quick example to get you started, **it's all you need**:

```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from 'react-nucleus';

function App() {
  return (
    <Button>
      Nucleus Button
    </Button>
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));
```

## Contribution

This project follows conventional commit messages using [commitlint](https://commitlint.js.org/). 
Hence please adhere to the conventions for your commit messages. 

Install Dependencies

```
npm install
```
Start the app using storybook
```
npm run storybook
```
Build react-nucleus Ui Core Components
```
npm run build
```

Generate a PAT with `admin:org`, `write:packages`, `read:packages`, `delete:packages`

Authenticate to npm github package

```
npm login --registry=https://registry.npmjs.org/
```

Publish the package to npm
```
npm publish
```

Deploy to Netlify
```
npm run deploy
```