@qred/qit-ui v2.0.20

@qred/qit-ui

Library with Qred Qit UI components

Installation

npm install

Deployment

To deploy Storybook locally run:

npm run storybook

storybook launches a local version of storybook using the .stories.js files in the components.

Deploy Storybook to GitHub Pages

First, build the new version of the ui components:

npm run build-storybook

Then, publish Storybook:

npn run deploy-storybook

deploy-storybook uses the gh-pages.sh file to upload the Storybook dist to the gh-pages repo, which is configured to work with GitHub Pages

Deployment to npm

It is recomended to work on develop branch until a new version is ready to be deployed. master branch is configured to work with semantic-release which automates the whole package release workflow (next version number, release notes, Git tags and publishing the package)

Merge develop branch into master and push to GitHub. Automtated deployment process is configured through CircleCI.

To push to the private NPM repo https://qredab.atlassian.net/wiki/spaces/PROD/pages/1423278081/Pushing+new+NPM+packages

Storybooks

https://qred.github.io/qit-ui

npm

https://www.npmjs.com/package/@qred/qit-ui

Qit UI Documentation

Panel

Usage

import { Panel } from '@qred/qit-ui';
...
<Panel></Panel>

Section

Usage

import { Section } from '@qred/qit-ui';
...
<Section> </Section>

Text

Usage

import { Text } from '@qred/qit-ui';
...
<Text> </Text>