rf-ui-library

UI Library for Renderforest future projects

Installation

npm i npm start

Demo

Demo url - https://renderforest.github.io/rf-ui-library/?path=/story/*

Structure

Here we use Atomic structure of project We have Atoms, Molecules, Organism For Typing we use FLOW (strict mode) All Helper functions places at src/helpers All components will be shown with storybook

Creating

For creating atom/molecule/organism we need use npm run create -- --type=atoms --name=Button command where in type we need to write type of component(atom/molecule/organism)

This command will crate all needed files in right directory By default all components will be functional, but if you want to create class component just add --class flag to command

After creating component, please add Demo example in stories to show usage

Deployment

npm run deploy npm run publish-module

Local testing

For local testing you need to use this command

npm run build-local

It will create local build without publishing new version and run npm pack command which will create a bundle according to ./lib/package.json. Bundle will be added in the main directory with name renderforest-rf-ui-library-{version}.tgz.

And in the module where you are using ui-lib run npm install ../rf-ui-library/{created_file_name} and you can see changes.

After testing please remove created file and if everything is ok, run npm run pubish-module which will create new bundle and publish new version for your changes and push changes to npm.