chakAs3 / nuxt-storybook

Storybook Module for Nuxt

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

1. Install dependencies with pnpm.
2. Run pnpm dev:prepare to generate stubbed dist directory.
3. Make your changes.
4. Run pnpm lint to verify that there is no issues (consider adding tests).
5. 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: [e-mail]

💬 Discord: ChakAs3

🐦‍⬛ Twitter: @ChakirQatab