cap-web-components

It's an light framework for web components development, supporting older browsers (IE11+). It is composed of an initial scaffolding and a rollup configuration for esm and umd modules generation.

LitElement is already installed an can be used out of the box.

Requirements

This plugin requires an LTS Node version (v8.0.0+) and npm (v5.0.0+).

Setup

Clone the project and install the dependencies:

git clone [email protected]:cap-web-components/cap-web-components.git
cd cap-web-components
npm i

NPM Scripts

start

Start a local development server on port 4200.

npm start

test

Run all unit tests and generate the coverage report. Unit tests are powered by Jest, for more information about how to implement them you can check their docs.

npm test

test:watch

Start an inmersive unit test developer experience, it allows you to focus on a specific set of tests and listens for changes on the files to run them again.

npm test:watch

build

Generate the vulcanized bundles in the dist folder. This command will generate a esm bundle to be used in modern browser that support modules and a umd bundle for browser that don't.

npm run build

This script generates an index.html file that includes all the bundles. You can use it as a reference to extract the bundles for other projects.

demo

Start a storybook demo server. By default it will add all files ending in .stories.js or stories.ts to the catalog.

npm run demo

demo:build

Generate the static files that contain the catalog with all the demo cases. By default the output will be generated in a catalog folder.

npm run demo:build