@plushfamily/ui-components
v0.0.18
Published
A library for shared UI Components across PLUSH Web Applications
Downloads
3
Keywords
Readme
Installation
Add the ui-components
package with either Yarn or NPM.
yarn add @plushfamily/ui-components
Structure
src/components/
contains all React components. All components that are exported from the package should be added tosrc/index.ts
.- Each component folder contains all Storybook stories demonstrating states of the components.
Requirements
- Use
Typescript
for components and stories - Lint the code with
yarn lint
(IDE usually does that) - Increment the package version in
package.json
according to Semantic Versioning
Releases and Storybook Deployment
Any Master update triggers building the Storybook and its deployment to https://storybook.plush.dev. This URL always references the latest version of Storybook.
Once a new version of the package is ready, create a GitHub release to publish it to the GitHub Packages Registry. It will also freeze the version of Storybook and deploy it to https://storybook.plush.dev/x.x.x.