https://github.com/eavichay/showroom

Universal development and automated test environment for web components
https://github.com/eavichay/showroom

automation bdd client-side javascript server-side tdd test-tools testing testing-tools web-components

Last synced: 4 days ago
JSON representation

Universal development and automated test environment for web components

• Host: GitHub
• URL: https://github.com/eavichay/showroom
• Owner: eavichay
• License: apache-2.0
• Created: 2018-10-15T21:24:11.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-04T00:41:45.000Z (about 4 years ago)
• Last Synced: 2024-10-24T06:21:10.346Z (12 days ago)
• Topics: automation, bdd, client-side, javascript, server-side, tdd, test-tools, testing, testing-tools, web-components
• Language: JavaScript
• Homepage: https://showroomjs.com
• Size: 15.2 MB
• Stars: 88
• Watchers: 3
• Forks: 8
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![showroom](../app/client/assets/showroom-bg.png)

# showroom: Universal development and automated test environment for web components

[![Build Status](https://semaphoreci.com/api/v1/eavichay/showroom/branches/master/badge.svg)](https://semaphoreci.com/eavichay/showroom)

### Installation

`npm install -g showroom`

create .showroom folder in your project

add descriptor files (see [example](https://github.com/eavichay/showroom/tree/master/example/.showroom)) for your web components.

run showroom and see the magic.

See [live demo here](https://showroomjs.com)

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 [email protected]:eavichay/showroom.git`

`npm install`

`npm run dev`

### Online Documentation/Wiki

[Here](https://github.com/eavichay/showroom/wiki)