README.md

Showcase.js

Showcase.js is a React story visualizer and test framework. Using Showcase, you can build a storybook-like environment for your React components and perform visual regression tests using your own CI.

View the documentation.

Quick Start

Installation

pnpm i @showcasejs/cli --save-dev

Usage

Use showcase dev to start the development server on port 6006.

showcase dev

Use showcase create-snapshots to create visual regression tests. Images will be output in the .showcase/snapshots directory.

showcase create-snapshots

Use showcase build to build the static site.

showcase build