Back to Next Js

Example app with Storybook

examples/with-storybook/README.md

16.2.51.6 KB
Original Source

Example app with Storybook

This example shows a default set up of Storybook using @storybook/nextjs. Included in this example are stories that demonstrate the ability to use Next.js features in Storybook.

TypeScript

As of v6.0, Storybook has built-in TypeScript support, so no configuration is needed. If you want to customize the default configuration, refer to the TypeScript docs.

Deploy your own

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

bash
npx create-next-app --example with-storybook with-storybook-app
bash
yarn create next-app --example with-storybook with-storybook-app
bash
pnpm create next-app --example with-storybook with-storybook-app

Run Storybook

bash
npm run storybook
# or
yarn storybook
# or
pnpm storybook

Build Static Storybook

bash
npm run build-storybook
# or
yarn build-storybook
# or
pnpm build-storybook

You can use Vercel to deploy Storybook. Specify storybook-static as the output directory.