open-index/open-npm huggingface dataset:
npm package: @kuos/lib
Description: Dashboard widgets components library.
Author: OpusCapita
Latest version: 1.1.0

## Development

### Run library locally:
Make sure you use node 14 (node -v to check)
1. Run `npm install` to install dependencies
2. Run `npm dev` to start the development server
3. In `local/index.tsx` there's a local playground for the library. Import the components you want to test and use them in the playground. Do not commit this file.

<br />

### Run tests
Make sure you use node 14 (node -v to check)
* Run `npm run test` to run the tests
* Run `npm run test:ui` to run UI for the tests

<br />

### Linting
* Run `npm run lint` to run the linter
* Run `npm run lint:fix` to run the linter and fix errors
* This library uses husky and lint-staged to run the linter on pre-commit

<br />

### Run test package in other project
1. (Optionally) Run `npm run release:dry` to report what would have done, if you publish the package
1. Run `npm pack` to create a tarball
2. Go to the project you want to test the package in and run `npm i -D <path to tarball>`, e.g.: `npm i -D '~/Desktop/dashboard-widgets/dashboard-widgets-0.0.1.tgz'`

<br />

### Publishing
1. Make sure if you are logged in to npm with the `npm whoami` and you are added to **OpusCapita** npm registry
1. Make sure your working directory is clean
2. Run `npm run release` to publish the package
3. Follow the steps in the terminal

<br />

### Contributing
1. Create a branch `feature/BNAPP-<ticket number>_<short description>`
2. On the branch, make your changes
3. Create tests and stories for each new component / use case **if applicable**
4. Run `npm run test` to make sure all tests pass
5. Commit those changes and create meaningful pull request
6. After PR is approved, merge it to master
7. Release the package to npm according to the `Publishing` instruction above