Skip to main content

Storybook Documentation Setup

This project uses Storybook for interactive component documentation that works alongside the Docusaurus site in apps/docs/.

Features​

  • ✅ Professional documentation solution
  • ✅ Works seamlessly with Expo Web
  • ✅ Interactive component demos
  • ✅ Can export as static site
  • ✅ TypeScript support
  • ✅ React Native Web compatibility

Getting Started​

Development​

Start the Storybook development server:

npm run storybook

This will start Storybook on http://localhost:6006

Build Static Site​

Build a static version of Storybook for deployment:

npm run build-storybook

The static files will be generated in the storybook-static directory.

Serve Static Build​

Serve the static build locally:

npm run storybook:serve

Configuration​

Storybook is configured in .storybook/:

  • main.ts - Main configuration file
  • preview.tsx - Global decorators and parameters
  • manager.ts - UI theme and branding

Writing Stories​

Stories are located alongside components:

components/
  Button.tsx
  Button.stories.tsx

Example story:

import type { Meta, StoryObj } from '@storybook/react';
import { Button } from './Button';

const meta: Meta<typeof Button> = {
  title: 'Components/Button',
  component: Button,
  tags: ['autodocs'],
};

export default meta;
type Story = StoryObj<typeof meta>;

export const Default: Story = {
  args: {
    children: 'Button',
  },
};

Integration with App​

The app's docs surface can include a button to open Storybook (web only). Configure the URL via EXPO_PUBLIC_STORYBOOK_URL.

Deployment​

Static Export​

  1. Build Storybook: npm run build-storybook
  2. Deploy the storybook-static directory to your hosting service
  3. Configure EXPO_PUBLIC_STORYBOOK_URL to point to the deployed Storybook

Netlify​

Add to netlify.toml:

[[redirects]]
  from = "/storybook/*"
  to = "/storybook/index.html"
  status = 200

AWS or Other Static Hosts​

Deploy Storybook to the same static hosting layer you use for the app shell, such as S3 + CloudFront, GitHub Pages, Netlify, or Vercel. The key requirement is a stable public URL for EXPO_PUBLIC_STORYBOOK_URL.

Troubleshooting​

React Native Web Compatibility​

Storybook is configured to handle React Native Web components via webpack aliases in .storybook/main.ts.

CSS Issues​

Global CSS is imported in .storybook/preview.tsx. Ensure all necessary stylesheets are imported there.

Resources​