kwikid-components-react/README.md

KwikID's Component Library in React

# kwikid-components-react

kwikid-components-react is a UI Component Library for KwikID, built using React.

## Installation

To use kwikid-components-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 kwikid-components-react and its dependencies using npm:

```bash
npm install kwikid-components-react
```

## Usage

```js
import React from "react";
import { KwikIDComponentReact } from "kwikid-components-react";

const App = () => {
  return (
    <div>
      <KwikIDComponentReact />
    </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/kwikid-components-react.git
cd kwikid-components-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.

### Deployment

For deployment, run the pipeline from Bitbucket repository in the PROD environment.

### Troubleshooting

If you encounter issues while contributing to this project or integrating the components in your application, then learn and solve it yourself and if still can't solve it then contact KwikID Team.

## License

This project is proprietary and confidential and is intended solely for use by authorized members of the KwikID.

Any unauthorized use, reproduction, or distribution of this software, in whole or in part, without the prior written consent of the company is strictly prohibited. This includes, but is not limited to, any external use, modification, or redistribution by third parties.