Use the Storybook CLI to install it in a single command. Run this inside your existing projectβs root directory:
sb init
is not made for empty projectsStorybook needs to be installed into a project that is already setup with a framework. It will not work on an empty project. There are many ways to bootstrap an app in given framework including:
During its install process, Storybook will look into your project's dependencies and provide you with the best configuration available.
The command above will make the following changes to your local environment:
Check that everything worked by running:
It will start Storybook locally and output the address. Depending on your system configuration, it will automatically open the address in a new browser tab and you'll be greeted by a welcome screen.
There are some noteworthy items here:
Now that you installed Storybook successfully, letβs take a look at a story that was written for us.
You can also setup Storybook manually through the Storybook CLI.
You can use the --type
flag to tell Storybook to configure itself based on the flag.
For instance you can use:
--type react
to setup Storybook with the React configuration options.--type vue
to setup Storybook with the Vue configuration options.--type angular
to setup Storybook with the Angular configuration options.If all else fails, try asking for help