# Storybook

Storybook is a free, open source frontend workshop for developing, testing, and documenting user interface (UI) components and pages in isolation. It is open source and self-hosted, installable on Proxmox.

Canonical page: https://ourlocalhost.com/app/4610/storybook

## Description

Storybook is a free, open source frontend workshop for developing, testing, and documenting user interface (UI) components and pages in isolation. It lets frontend developers build and preview individual components, pages, and design-system elements outside the main application, with built-in interaction and visual testing and living documentation. It is aimed at frontend developers and design teams, and is useful for catching UI defects early, collaborating on component specifications, and generating reusable documentation from the components themselves.

## Platform availability

Available on 2 of 10 platforms: Proxmox, Any server.

## Health score

84/100 (Excellent), based on 3 of 4 factors.
- Maintained: 100 (last commit 4 days ago)
- Popular: 99 (91,615 GitHub stars)
- Easy to install: 35 (2 install platforms, install notes)

## Links

- Official website: https://storybook.js.org
- GitHub: https://github.com/storybookjs/storybook
- Documentation: https://storybook.js.org/docs
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=storybook

## Common questions

### What setup is required before starting Phoenix Storybook?

Add the dependency, run mix phx.gen.storybook, and set otp_app, content_path, js_path, and css_path in the generated module. The asset paths must be URLs your app serves, and wrong values can cause setup failure or an empty UI.

### What limitations apply when publishing Storybook to a static web host?

Storybook can be published to hosts such as GitHub Pages, Netlify, or AWS S3 because it is built as a static web application. Features such as Composition, embedding stories, history, versioning, and assets may require tighter integration.

### Why does Storybook add many dependencies to a project?

Storybook is a large app with many dependencies. It has historically pulled in its own webpack, webpack plugins, Babel plugins, and emotion.

### Where can users get help with Storybook issues?

Users can share their issue in the repository's GitHub Discussions.

---
Source: Our Local Host (https://ourlocalhost.com/app/4610/storybook), the self-hosted and open-source app directory.
