nicole-ui-storybook-v6 v0.5.3

common-ui

This project includes all the components of Zerologix product, base on Material-UI.

DEV demo site

Env

Node: v14.17.6

Material-UI: v5.0.2

Develope

npm install
npm run dev

Usage

1. Update following config into .npmrc, then execute npm install @zerologix/common-ui

 @zerologix:registry=https://gitlab.com/api/v4/packages/npm/
'//gitlab.com/api/v4/packages/npm/:_authToken'="FZ5EeVwSDAGd7AELbq9t"
'//gitlab.com/api/v4/projects/29988775/packages/npm/:_authToken'="FZ5EeVwSDAGd7AELbq9t"

2. Set command npm install @zerologix/common-ui@rc into dev flow, the command will install the latest rc version.

Develope Flow

1. Checkout new feature branch from develop branch.

2. When finished develope, please have a pull request into develop branch.

3. After merge into develop, gitlab will auto deploy into storybook dev website and publish prerealse package version which tagged rc.

4. Go to your project run npm install @zerologix/common-ui@rc

• NOTE: Please choose squash and merge option as merge strategy.

Develope Guide

• Follow CSF to write story, define on storybook document.

• Stories put at the same level with component.

• DO NOT write any test about UI level and behavior level.

• Story only dependent on components.

• Write all of override config on mui component at /theme/override.