e190a8cdb9
- Emphasize requirement to install in existing project
- Add link to Troubleshooting section
- Update welcome screenshot to include correct "edit" filename
- Re-arrange content order, so that Troubleshooting isn't last
- Update React Storybook examples
- Remove react-native-web, as that project no longer uses Storybook
- Point to SB Design System instead of react-dates, as it uses modern features
3.7 KiB
| title |
|---|
| Install Storybook |
<FeatureSnippets paths={[ 'get-started/installation-command-section/angular.mdx', 'get-started/installation-command-section/ember.mdx', 'get-started/installation-command-section/html.mdx', 'get-started/installation-command-section/marko.mdx', 'get-started/installation-command-section/mithril.mdx', 'get-started/installation-command-section/preact.mdx', 'get-started/installation-command-section/rax.mdx', 'get-started/installation-command-section/react.mdx', 'get-started/installation-command-section/riot.mdx', 'get-started/installation-command-section/svelte.mdx', 'get-started/installation-command-section/vue.mdx', 'get-started/installation-command-section/web-components.mdx', ]} />
sb init is not made for empty projects
Storybook needs to be installed into a project that is already set up with a framework. It will not work on an empty project. There are many ways to bootstrap an app in a given framework including:
- 📦 Create an Angular Workspace
- 📦 Create React App
- 📦 Vue CLI
- 📦 Ember CLI
- Or any other tooling available.
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:
- 📦 Install the required dependencies.
- 🛠 Set up the necessary scripts to run and build Storybook.
- 🛠 Add the default Storybook configuration.
- 📝 Add some boilerplate stories to get you started.
Depending on your framework, first build your app and then check that everything worked by running:
<CodeSnippets paths={[ 'common/storybook-run-dev.npm.js.mdx', 'common/storybook-run-dev.yarn.js.mdx', ]} />
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:
- A collection of useful links for more in depth configuration and customization options you have at your disposal.
- A second set of links for you to expand your Storybook knowledge and get involved with the ever growing Storybook community.
- A few example stories to get you started.
Troubleshooting
Below is a curated list to get you unblocked while adding Storybook to your project.
<FeatureSnippets paths={[ 'get-started/installation-problems/angular.mdx', 'get-started/installation-problems/ember.mdx', 'get-started/installation-problems/html.mdx', 'get-started/installation-problems/marko.mdx', 'get-started/installation-problems/mithril.mdx', 'get-started/installation-problems/preact.mdx', 'get-started/installation-problems/rax.mdx', 'get-started/installation-problems/react.mdx', 'get-started/installation-problems/riot.mdx', 'get-started/installation-problems/svelte.mdx', 'get-started/installation-problems/vue.mdx', 'get-started/installation-problems/web-components.mdx', ]} />
If all else fails, try asking for help
Now that you installed Storybook successfully, let’s take a look at a story that was written for us.