https://github.com/yuan-alex/showcase

Showcase is a React UI component story visualizer from the future.
https://github.com/yuan-alex/showcase

components react reactjs stories testing

Last synced: 12 days ago
JSON representation

Showcase is a React UI component story visualizer from the future.

• Host: GitHub
• URL: https://github.com/yuan-alex/showcase
• Owner: yuan-alex
• License: mit
• Created: 2023-01-12T00:47:23.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-02T23:17:04.000Z (about 1 year ago)
• Last Synced: 2024-10-27T20:17:20.521Z (24 days ago)
• Topics: components, react, reactjs, stories, testing
• Language: TypeScript
• Homepage: https://showcasejs.org
• Size: 2.66 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://showcasejs.org).

## Quick Start

### Installation

```bash

pnpm i @showcasejs/cli --save-dev

```

### Usage

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

```bash

showcase dev

```

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

```bash

showcase create-snapshots

```

Use `showcase build` to build the static site.

```bash

showcase build

```