kwikui-react/README.md

KwikID's UI Component Library in React

# KwikUI-React

KwikUI-React is a UI Component Library for KwikID, built using React.

## Installation

To use KwikUI-React in your project, make sure you have the following peer dependencies installed:

- React (>=16.12.0)
- React DOM (>=16.12.0)

You can install KwikUI-React and its dependencies using npm:

```bash
npm install kwikui-react
```

## Usage

```js
import { KwikUIButton } from "kwikui-react";
import React from "react";

const App = () => {
  return (
    <div>
      <KwikUIButton />
    </div>
  );
};

export default App;
```

For more details on the available components and their usage, check out the [documentation](https://docs.getkwikid.com/).

## Development

To set up the development environment, clone the repository and install the required dependencies:

```bash
git clone https://bitbucket.org/team360noscope/kwikui-react.git
cd kwikui-react
npm install
```

### Available Scripts

In the project directory, you can run:

```bash
npm start
```

Runs the development environment.

Open http://localhost:3000 to view the components in your browser.

The page will reload when you make changes. You may also see any lint errors in the console.

```bash
npm test
```

Launches the test runner in interactive watch mode.

See the documentation on running tests for more information.

```bash
npm run build
```

Builds the library for production to the dist folder.