mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-07 07:21:17 +08:00
27 lines
836 B
Markdown
27 lines
836 B
Markdown
---
|
|
id: 'quick-start-guide'
|
|
title: 'Quick Start Guide'
|
|
---
|
|
|
|
Storybook is very easy to use. You can use it with any kind of React or Vue project.
|
|
Follow these steps to get started with Storybook.
|
|
|
|
```sh
|
|
cd my-project-directory
|
|
npm i -g @storybook/cli
|
|
getstorybook
|
|
```
|
|
The `-g` global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install, take a look at our [Slow Start Guide](/basics/slow-start-guide/).
|
|
|
|
This will configure your app for Storybook. After that, you can run your Storybook with:
|
|
|
|
```sh
|
|
npm run storybook
|
|
```
|
|
|
|
Then you can access your storybook from the browser.
|
|
|
|
* * *
|
|
|
|
To learn more about what `getstorybook` command does, have a look at our [Start Guide for React](/basics/guide-react/) or [Start Guide for Vue](/basics/guide-vue/).
|