Skip to content

eavichay/showroom

Repository files navigation

showroom

showroom: Universal development and automated test environment for web components

Build Status

Installation

npm install -g showroom

create .showroom folder in your project add descriptor files (see example) for your web components.

run showroom and see the magic.

See live demo here

Supports:

  • Any stack: Polymer, LitElement, Slim.js, Vanilla, Skate,...
  • Supports customized built-in elements (i.e. extends HTMLInputElement)
  • Supports innerHTML and wrapping HTML
  • Supports global/local scripting and styling
  • Supports CI/CD queries for shadow-roots
  • Smooth pupeteer integration

Configuration

The server following options:

  • port (int) - The port on which the server listens. Default is 3000.
  • path (string) - The path, relative to the process.cwd(), used to search for project files. Default is ./.
  • silent (boolean) - If true, completely disables logging. Default is false.
  • verbose (boolean) - If true, verbose messages will be logged. Otherwise only errors and warnings will be logged. Default it false.

Build & Development

git clone git@github.com:eavichay/showroom.git npm install npm run dev

Online Documentation/Wiki

Here