/glorious-pitsby-demo-web-components

A simple demo of web components documented with Pitsby

Primary LanguageJavaScriptMIT LicenseMIT

Glorious Pitsby Demo (Web Components)

Demo documentation generated with https://pitsby.com

CircleCI Coverage Status

Contributing

  1. Install Node. Download the "Recommend for Most Users" version.

  2. Clone the repo:

git clone git@github.com:glorious-codes/glorious-pitsby-demo-web-components.git
  1. Go to the project directory
cd glorious-pitsby-demo-web-components
  1. Install the project dependencies
npm install
  1. Otherwise, run:
npm run start

The app will be running on http://localhost:7000.

Tests

  1. Ensure that all code that you have added is covered with unit tests:
npm run test
  1. You can optionally generate coverage report after running tests:
npm run test -- --coverage