https://github.com/storybook-vue/nuxt-storybook

Storybook Module for Nuxt Framework
https://github.com/storybook-vue/nuxt-storybook

nuxt-module nuxt3 nuxtjs storybook storybook-addon storybookjs

Last synced: 3 months ago
JSON representation

Storybook Module for Nuxt Framework

• Host: GitHub
• URL: https://github.com/storybook-vue/nuxt-storybook
• Owner: storybook-vue
• Created: 2023-08-28T09:52:43.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-09T02:10:38.000Z (over 1 year ago)
• Last Synced: 2024-10-18T09:22:03.310Z (4 months ago)
• Topics: nuxt-module, nuxt3, nuxtjs, storybook, storybook-addon, storybookjs
• Language: TypeScript
• Homepage:
• Size: 130 KB
• Stars: 18
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

![sb-nuxt-github (1)](https://github.com/storybook-vue/nuxt-storybook/assets/711292/7e64e6cc-7d03-469d-91e6-48fa6754a52f)

# nuxt-storybook

Storybook Module for Nuxt Framework

> [Storybook](http://storybookjs.org) module for [Nuxt](https://nuxtjs.org)

>

## Installing

`pnpm add @storybook-vue/nuxt-storybook -D`

update your nuxt.config

```ts

  modules: [

    '@storybook-vue/nuxt-storybook',

  ],

  storybook: {

    url: 'http://localhost:6006',

    storybookRoute: '/__storybook__',

    port: 6006,

  },

```

`pnpm dev`

## Demo

https://github.com/chakAs3/nuxt-storybook-module-demo

## 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](LICENSE). Feel free to use the code and modify it according to your needs.

## Contacts :

🔖 Mail: [email protected]

💬 Discord: ChakAs3

🐦‍⬛ Twitter: [@ChakirQatab](https://twitter.com/ChakirQatab)