0.0.16 • Published 12 months ago
feer-p-lib v0.0.16
p-lib
This project is a public component library.
It has a storybook to check and see the documentation of the components.
The project has Eslint + prettier, Stylelint, tests with Vitest + React testing library. Plus all of this runs on pre-commit with Husky.
How to use this repo?
1. Clone or copy
Download the repo, cloning or copying it.
Project setup
Environment
For running the project, you need to have installed the proper versions of node and yarn.
When you are ready to start:
# Install node version with NVM if you are using it.
nvm install
# Then install yarn
npm install -g yarn@^1.22.10
Dependencies
When you are all ready to go, proceed to install dependencies with yarn.
yarn
Development scripts
Compiles and hot-reloads for development
yarn dev
Run your unit tests
yarn test
Lints and fixes files
yarn lint
Lints scss files
yarn lint:css
Run storybook
yarn storybook