@kenlo/design-system
v3.0.0
Published
React cross-project components for Kenlo
Maintainers
Keywords
Readme
:rocket: Technologies
This project was developed with the following technologies:
:package: Setup development
Install project
Use recommended node version
$ nvm install
$ nvm useInstall dependencies
$ npm installRun storybook
$ npm run devRun unit tests
$ npm run test:watch
or
# npm run test:uiRun Typescript type checks
$ npm run typecheck
or
$ npm run typecheck:watchGenerate tarball to use for testing in another project
$ npm packInstall tarball (from the other project)
$ npm install path/to/this/repo/kenlo-design-system-version.tgzFor production
Run all tests and generate coverage report
$ npm run test:coverageBuild Storybook
$ npm run buildBuild Library
$ npm run build:libDeploy Library to NPM
- Remember to change
package.jsonversion beforehand
$ npm run deploy:package: Installation
Components styles
import "@kenlo/design-system/style.css";SASS variables
@import "@kenlo/design-system/tokens.scss";Webpack/Vite/Rollup, etc...
On the sass-loader plugin config, add the following option:
additionalData: '@use "@kenlo/design-system/tokens.scss";'Using Tailwind?
@import "@kenlo/design-system/tailwind.css";