storybook
Easily integrate Storybook in your Nuxt application to design, build, and organize your UI components in isolation.
Nuxt Storybook
Integrate Storybook into your Nuxt application.
Installing
pnpm add -D @storybook-vue/nuxt-storybook
Update your nuxt.config
:
modules: [ '@storybook-vue/nuxt-storybook', ], storybook: { url: 'http://localhost:6006', storybookRoute: '/__storybook__', port: 6006, },
Then run pnpm dev
to start you Nuxt server.
Demo
https://github.com/chakAs3/nuxt-storybook-module-demo
Features
๐ Zero configuration to start (see video) ๐ช Access Storybook Terminal ๐จ Devtools tab with Storybook app โ๏ธ Reference your Storybook config in your app ๐ฆ Extendable by Nuxt modules ๐ Supports both Nuxt 3 and Nuxt 2
Contributing
- Install dependencies with
pnpm
. - Run
pnpm dev:prepare
to generate stubbeddist
directory. - Make your changes.
- Run
pnpm lint
to verify that there is no issues (consider adding tests). - Submit a PR.
License
This repository is licensed under the MIT License. Feel free to use the code and modify it according to your needs.
Contacts :
๐ Mail: javachakir@gmail.com
๐ฌ Discord: ChakAs3
๐ฆโโฌ Twitter: @ChakirQatab