rsnext/examples/with-storybook
Ethan Arrowood d31ced1d26
update storybook example (copy from vercel/vercel) (#50865)
Updates the `with-storybook` example to be the example located in [`vercel/vercel`](https://github.com/vercel/vercel/tree/main/examples/storybook). 

The motivation for this change is that we now have better support for storybook. It is now treated as its own framework and so users can specify the `storybook` framework as well as custom build command `build-storybook` in order to get near zero-config support 🌟 

Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
2023-06-14 03:18:44 +00:00
..
.storybook update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
app update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
public update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
stories update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
.gitignore update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
next.config.js update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
package.json update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04:00
tsconfig.json update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00
vercel.json update storybook example (copy from vercel/vercel) (#50865) 2023-06-14 03:18:44 +00:00

Example app with Storybook

This example shows a default set up of Storybook using storybook-addon-next. 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

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

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

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

Run Storybook

npm run storybook
# or
yarn storybook

Build Static Storybook

npm run build-storybook
# or
yarn build-storybook

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