Installation

Learn how to get React Showroom up and running in your project.


1. Install React Showroom

npm i -D react-showroom
bash

2. Start Showroom for Development

npx react-showroom dev
bash

All components in src/components folders will be automatically parsed and listed. You can customize what components are loaded via configuration.

You probably want to add a npm script in your package.json:

package.json
{
...
"scripts": {
...
"start": "react-showroom dev"
}
}
json

3. Build Showroom for Deployment

npx react-showroom build
bash

You probably want to add a npm script in your package.json:

package.json
{
...
"scripts": {
...
"start": "react-showroom build"
}
}
json