@freshworks/react-nucleus

react-nucleus

Nucleus design system in React based on Styled Components

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://[e-mail]/freshworksinc/react-nucleus.git@0.1.3

Usage

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

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