Skip to content

Instantly share code, notes, and snippets.

@tpitre

tpitre/README.md

Last active November 5, 2021 16:51
Show Gist options
  • Save tpitre/7d703b3d3df7dec56ae2cf722bc53d53 to your computer and use it in GitHub Desktop.
Save tpitre/7d703b3d3df7dec56ae2cf722bc53d53 to your computer and use it in GitHub Desktop.
Download ZIP
Storybook (Vue) Component UI Dependencies and Deployment Steps
Raw
README.md

Andover component library

Storybook for Vue component libary for rapid development.

Dependecies

This component library utilizes the following dependecies.

Getting started

  1. Match your node version to the version defined in .nvmrc
  2. Install yarn, or if already install skip to the below
  3. Run yarn to install all dependencies
  4. Run yarn storybook to get a local storybook instance running
  5. Run yarn build to get your build under lib which can be used for publishing a npm pacakge

App Integration

  • Please review the peer dependecies in the package.json file. These will be necessary dependecies if you wish to utilize the component library as an npm module.
  • It's possible to build your app around this repo in a mono repo paradiagm. If restructuring the folders/files make sure to update any dependcy paths.
  • You will need to provide a theme in your application which the components will consume. Use .storybook/preview.js as an example for how to utlize the theme file src/theme/index.js in your app.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment