@freska/freska-ui

Freska UI Components

React component library designed to help developers create unified Freska experience across different frontends.

Using the React components

TODO

Style guide

Run the following command to start style guide dev server:

npm run styleguide

Run the following command to build a static version of style guide:

npm run styleguide:build

Publishing New Version to NPM

Before updates in master can be used in external projects, a new NPM version has been published. To do so, follow these steps:

Don't have (or don't know if you have) versioning and publishing rights? Let somebody know.

1. First, build the styleguide to include the latest updates.

Before updates in master can be used in external projects, a new NPM version has to be published. To do so, follow these steps:

npm run build

2. Then increment the NPM version by using:

• major is for large X.0.0 changes
• minor is for smaller but substantial updates such as entirely new components
• patch is probably the most common used for small updates to existing components

npm version major|minor|patch

3. Push the latest build to Github

git push

4. Finally, publish the latest version to NPM

npm publish