@cliqmind/rv-components
v0.12.2-dev.18
Published
[![Version](https://img.shields.io/npm/v/@cliqmind/rv-components.svg)](https://www.npmjs.com/package/@cliqmind/rv-components) ![Prerequisite](https://img.shields.io/badge/node-%3E%3D18.0.0-blue.svg) [![License: UNLICENSED](https://img.shields.io/badge/L
Downloads
24
Readme
@cliqmind/rv-components
Cliqmind UI framework
Prerequisites
- node >=18.0.0
- asd
Usage
Install the core package as production dependency via
yarn add @cliqmind/rv-components
commandInstall the needed peer dependencies as production/development dependencies:
- development (needed for compiling the project before distribution):
yarn add -D sass style-inject tslib@^2.4 clsx
- production:
yarn add i18next@^23 @popperjs/core@^2.11 p-queue ramin-modern-calendar-datepicker react-animate-height react-modal react-loading-skeleton react-popper react-select@^5.7 react-toastify
- development (needed for compiling the project before distribution):
install and configure the I18n in project by the instructions provided in I18n setup
Development and contributions
To begin with development of the package:
- clone the
rv-components
repo. - install the dependencies via
yarn install
. - start storybook development server via
yarn storybook
.
- clone the
To build the package for distribution:
- remove the dist directory via
yarn build:clear-dist
. - initiate the es/cjs compiling with rollup via
yarn build:rollup
. - copy the required project assets (fonts/raw scss/images/etc.) via
yarn build:scss
. - copy the main project files (package.json/readme/changelog) to the dist folder via
yarn postbuild
.
- or just use the
yarn build
command :grin:.
- remove the dist directory via
The rv-components is compatible with node 18 aka LTS/hydrogen engine.