# WE OVER I React Component Libraries

## Prerequisites
This project requires NodeJS (version 18 or later) and NPM.
[Node](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.
To make sure you have them available on your machine,
try running the following command.
```sh
$ npm -v && node -v
9.6.7
v18.17.1
```

## Installation
```sh
$ npm install --save woi-react-storybook
```

## Documentation

- 📒 [Components](#components)
  - [Buttons](https://github.com/We-Over-I-Engineering/react-libraries/blob/main/docs/Buttons.md): WOI Button components.
  - [Checkbox](https://github.com/We-Over-I-Engineering/react-libraries/blob/main/docs/Checkbox.md): WOI Checkbox components.
  - [Switch](https://github.com/We-Over-I-Engineering/react-libraries/blob/main/docs/Switch.md): WOI Switch components.
  - [TextField](https://github.com/We-Over-I-Engineering/react-libraries/blob/main/docs/TextField.md): WOI TextField components.
  - 
- 👏 [Contributing](#contributing)
  - 👨‍💻 [Development scripts](#development-scripts)
- :memo: [License](#license)

## Contributing

Contributions to We Over I React Component Libraries are always welcome!

1.  Fork it!
2.  Create your feature branch: `git checkout -b my-new-feature`
3.  Add your changes: `git add .`
4.  Commit your changes: `git commit -am 'Add some feature'`
5.  Push to the branch: `git push origin my-new-feature`
6.  Submit a pull request :sunglasses:

### Development scripts

- `yarn` - install all dependencies

or 

- `npm install` - install all dependencies

- `yarn storybook` - start the storybook server on port 6006
- `yarn build` - build the storybook for production
 or 

- `npm run storybook` - start the storybook server on port 6006
- `npm run build` - build the storybook for production

## **Authors**

- **Muhammad Farooq** - [Muhammad Farooq](https://github.com/hafizmuhammadfarooq786)
- **Usman Wadood** - [Usman Wadood](https://github.com/usmanwadood)

## **Contact**

- **Muhammad Saad** - [saad@we-over-i.com](mailto:saad@we-over-i.com)
- **WE OVER I Engineering Lab** - [tech@we-over-i.com](mailto:tech@we-over-i.com)

## License
This project is licensed under the MIT license, Copyright (c) 2023 We Over I. 
For more information see `LICENSE.md`.

## Publish to NPM
- `npm login`
- `npm publish --access public`