ui-x-library v1.1.26

UI Components Library

Build and upload ReactJS components to NPM

Rationale

In essence, this application allows you to build UI components library in isolation using Styleguidist - in other words you can build and preview them independently from any particular brand. Also generates a dist folder ready to be pushed to the NPM using a few familiar commands.

Building and Running

:warning: Check .env.example file for required variables!

Install all required dependencies:

yarn

Launch Styleguidist ( initial load takes time, subsequently webpack cache kicks in )

yarn styleguide

Launch Create React App if you want to preview components outside of Styleguidist

yarn start

Generate NPM dist package using Rollup:

yarn build-for-npm

Run tests:

yarn test

How to test your NPM module without publishing!

Use yalc !

Better workflow than npm | yarn link for package authors - read docs.

Install yalc globally:

yarn global add yalc

Inside ui-library root execute:

yarn build-for-npm

Then publish to yalc (located ~/.yalc):

yalc publish

Add to another local FE project:

yalc add ui-library

To update library after some changes

yarn build-for-npm && yalc publish --push

Publish to NPM

:warning: Don't forget to bump ui-library package version!

Versioning

Then run npm publish - assuming you have \${NPM_TOKEN} set on your local machine in your ~/.profile or logged into npm via CLI.

See npm docs for more info.

Project Structure

Changelogs

Use a CHANGELOG markdown file to keep changes of repository in an ordered and structured way.

Recommended template to use for each bullet of the changelog.

## [1.0.0] - YYYY-MM-DD

### Changes

- commit message