@galaxy_ui/ui/README.md

UI library for the React apps

# galaxy UI

Galaxy UI is a collection of React web components that help you build web applications faster.

[![Code-coverage](https://img.shields.io/codecov/c/github/onemanfighter/galaxy-ui)](https://codecov.io/github/onemanfighter/galaxy-ui)

[![Code-coverage](https://codecov.io/github/onemanfighter/galaxy-ui/graph/badge.svg?token=VE9SQ4E4SI)](https://codecov.io/github/onemanfighter/galaxy-ui)

[![galaxy UI Lint-Test](https://github.com/onemanfighter/galaxy-ui/actions/workflows/main.yaml/badge.svg)](https://github.com/onemanfighter/galaxy-ui/actions/workflows/main.yaml)
[![galaxy UI Publish job](https://github.com/onemanfighter/galaxy-ui/actions/workflows/publish-npm.yaml/badge.svg)](https://github.com/onemanfighter/galaxy-ui/actions/workflows/publish-npm.yaml)

UI Library for the galaxy project, which is a collection of React web components.

[![npm version](https://badge.fury.io/js/%40galaxy_ui%2Fui.svg)](https://badge.fury.io/js/%40galaxy_ui%2Fui)
[![npm](https://img.shields.io/npm/dm/%40galaxy_ui%2Fi)](https://www.npmjs.com/package/@galaxy_ui/ui)
![GitHub license](https://img.shields.io/github/license/onemanfighter/galaxy-ui)
![GitHub issues](https://img.shields.io/github/issues/onemanfighter/galaxy-ui)
![GitHub forks](https://img.shields.io/github/forks/onemanfighter/galaxy-ui)
![GitHub stars](https://img.shields.io/github/stars/onemanfighter/galaxy-ui)

## Library hosted on Netlify

[![Netlify Status](https://api.netlify.com/api/v1/badges/b6f0e253-0cde-444f-99ff-75a8a2a21a84/deploy-status)](https://app.netlify.com/sites/galaxy-ui/deploys)

- [galaxy-ui](https://galaxy-ui-sb.netlify.app/)

## Chromatic Storybook

[![Chromatic](https://img.shields.io/badge/Chromatic-Storybook-FF4785?logo=storybook)](https://www.chromatic.com/library?appId=660b6f1cba8a33d3e2049592)

- [Chromatic link](https://www.chromatic.com/library?appId=660b6f1cba8a33d3e2049592)

## Installation

```bash
npm install @galaxy_ui/ui
or
npm i @galaxy_ui/ui
```

OR

```bash
yarn add @galaxy_ui/ui
```

## Usage

**Basic component usage syntax:**

```jsx
import React from 'react';
import { Button } from '@galaxy/ui';

const App = () => <Button>Click me</Button>;

export default App;
```

## License

- [MIT](https://github.com/onemanfighter/galaxy-ui/blob/development/LICENSE)

## Documentation and Examples

- [Storybook](https://onemanfighter.github.io/galaxy-ui/)

## Author and Maintainer

- [Amit Raikwar - onemanfighter](https://github.com/onemanfighter)
- [Amit Raikwar - Github](https://github.com/raikwaramit)
- [Amit Raikwar LinkedIn](https://in.linkedin.com/in/amitrai1603)