2021-06-18 08:10:03 -04:00
---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
# Storybook
2022-07-21 17:10:17 -04:00
The Storybook for the `gitlab-org/gitlab` project is available on our [GitLab Pages site ](https://gitlab-org.gitlab.io/gitlab/storybook/ ).
2021-06-18 08:10:03 -04:00
## Storybook in local development
Storybook dependencies and configuration are located under the `storybook/` directory.
To build and launch Storybook locally, in the root directory of the `gitlab` project:
1. Install Storybook dependencies:
```shell
yarn storybook:install
```
1. Build the Storybook site:
```shell
yarn storybook:start
```
## Adding components to Storybook
Stories can be added for any Vue component in the `gitlab` repository.
To add a story:
1. Create a new `.stories.js` file in the same directory as the Vue component.
2021-09-28 08:11:10 -04:00
The filename should have the same prefix as the Vue component.
2021-06-18 08:10:03 -04:00
```txt
vue_shared/
├─ components/
2021-07-05 02:08:01 -04:00
│ ├─ sidebar
2021-10-01 08:13:32 -04:00
│ | ├─ todo_toggle
│ | | ├─ todo_button.vue
│ │ | ├─ todo_button.stories.js
2021-06-18 08:10:03 -04:00
```
2021-07-02 14:08:28 -04:00
1. Write the story as per the [official Storybook instructions ](https://storybook.js.org/docs/vue/writing-stories/introduction/ )
2021-07-01 14:07:29 -04:00
2021-06-18 08:10:03 -04:00
Notes:
2021-11-06 14:13:37 -04:00
- Specify the `title` field of the story as the component's file path from the `javascripts/` directory.
For example, if the component is located at `app/assets/javascripts/vue_shared/components/sidebar/todo_toggle/todo_button.vue` , specify the story `title` as `vue_shared/components/sidebar/todo_toggle/todo_button` . This will ensure the Storybook navigation maps closely to our internal directory structure.
2021-09-30 14:11:31 -04:00
## Mock backend APIs
2022-05-20 14:07:48 -04:00
The GitLab Storybook uses [MirajeJS ](https://miragejs.com/ ) to mock REST and GraphQL APIs. Storybook shares the MirajeJS server
2021-09-30 14:11:31 -04:00
with the [frontend integration tests ](../testing_guide/testing_levels.md#frontend-integration-tests ). You can find the MirajeJS
configuration files in `spec/frontend_integration/mock_server` .