Page cover image

Getting started with Storybook


  • storybook that holds stories to be tested

  • lost-pixel configuration file

  1. Follow this storybook guide to add it to your project in minutes

  2. Add lost-pixel configuration file

  3. Add action file in the root of your project. In .github/workflows/ci.yml

    on: [push]
        runs-on: ubuntu-latest
          - name: Checkout
            uses: actions/checkout@v3
          - name: Setup Node
            uses: actions/setup-node@v3
              node-version: 18.x
              cache: "npm"
          - name: Install dependencies
            run: npm install
          - name: Build Storybook
            run: npm run build-storybook
          - name: Lost Pixel
            uses: lost-pixel/lost-pixel@3.3.0
pageAutomatic baseline update PR

Note that your lostpixel.config.js|ts|cjs|mjs should point to the correct relative path to the built storybook or to served storybook URL

After writing your first stories, you can adopt the visual regression testing by following the visual regression testing workflow

You can see some popular integrations in the lost-pixel-examples directory

Last updated