https://github.com/sparkbox/vue-storybook-starter
A Starter Vue Storybook Project
https://github.com/sparkbox/vue-storybook-starter
Last synced: 6 months ago
JSON representation
A Starter Vue Storybook Project
- Host: GitHub
- URL: https://github.com/sparkbox/vue-storybook-starter
- Owner: sparkbox
- License: mit
- Created: 2020-05-06T14:37:13.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T05:30:57.000Z (9 months ago)
- Last Synced: 2024-12-17T02:03:13.558Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.18 MB
- Stars: 3
- Watchers: 18
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vue Storybook Starter
=====================
A Vue Storybook Starter project that is setup with the a11y, Jest, Controls, Percy, and StoryShots addons.
## Project setup
1. Run `npm install` to download dependencies.
2. Run `npm run test` to run Jest and StoryShots.
* We need to do this before running storybook in order to generate the `.jest-test-results.json` file, which is used by the Jest Storybook Addon.
3. Run `npm run storybook` to run Storybook locally. You should see a new browser tab open with Storybook running.
4. Run `npm run snapshot` to generate Percy snapshots. You will need a Percy account with a project and your `PERCY_TOKEN` for authentication.
## Storybook Addons
- [a11y](https://github.com/storybookjs/storybook/tree/next/addons/a11y)
- [Jest](https://github.com/storybookjs/storybook/tree/master/addons/jest)
- [Controls](https://github.com/storybookjs/storybook/tree/next/addons/controls)
- [Percy](https://github.com/percy/percy-storybook)
- [StoryShots](https://github.com/storybookjs/storybook/tree/next/addons/storyshots/storyshots-core)