Skip to content

davestaab/vue-cli3-storybook

Repository files navigation

Vue cli3 Storybook setup

This repo is a minimal setup for a vue cli3 project to use Storybook.

Updated to work with latest @vue/cli 3.0.0-rc.1

To run this repo directly

$ git clone https://github.com/davestaab/vue-cli3-storybook
$ yarn
$ yarn storybook

To setup manually

Assumptions

I assume the following versions

$ node -v 
v8.11.2

$ yarn -v
1.7.0

Install Vue cli

yarn global add @vue/cli

vue --version
3.0.0-rc.1

Manual Setup

To setup from scratch take the following steps

  1. vue create <folder-name>
  2. choose default preset (babel, eslint)
  3. cd <folder-name>
  4. yarn add --dev babel-core@7.0.0-bridge.0
  5. yarn add --dev @storybook/vue
  6. yarn add --dev vue-template-compiler
  7. add storybook cmd to package.json
    "scripts": {
        "storybook": "start-storybook -p 9001 -c .storybook"
        ...
    }
    
  8. add config for babel in .storybook/.babelrc
    1. Babel config
  9. add config for webpack in .storybook/webpack.config.js
    1. Webpack config
  10. add storybook config file in .storybook/config.js
    1. Storybook config
  11. add a story for component in src/components/HelloWorld.story.js
    1. HelloWorld Story
  12. Done! Run storybook
    1. yarn storybook

To Run

  • yarn serve - run the vue application
  • yarn storybook - run storybook

Status

Currently working with the following dependencies.

  • @vue/cli 3.0.0-rc.1
  • @storybook/vue 3.4.7
  • babel-core 7.0.0-bridge.0
  • vue-template-compiler 2.5.16

About

example setup of storybook with Vue cli 3

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published