@cheyer/npm-package-example v1.1.0

UI Library Example

Shareable UI components library

• automated release process with auto
• published as npm package
• storybook docs deployed with github pages so it can be used as a ref design system

Getting Started

$ yarn

$ yarn start

This will start storybook which is also used as development environment for the stories.

Release Process

This repository uses auto to automatically generate releases and publish them to npm. Also storybook is build and published with github pages.

In order to create a release, simply tag your PR with https://github.com/chris-heyer-planetly/npm-package-example/labels/patch, https://github.com/chris-heyer-planetly/npm-package-example/labels/minor or https://github.com/chris-heyer-planetly/npm-package-example/labels/major label. Once the PR is merged, auto will generate the release.

Further Ideas

• Private Package: Make the npm package private
• Auto Updates: Auto update dependency version in consumers with dependabot

Links

• UI Library Storybook
• UI Library Consumer Github
• UI Library NPM Package

References

• How to publish Storybook Docs with Github Pages
• How to create UI library NPM package