wcg.ui.kit v0.0.24

WCG UI Kit

Stencil Library with angular and react outputs documented in the playbook. This is an example architecture of how this can work.

Table of Contents

• Requirements
• Getting Started
• Available Yarn Scripts
• Generate Library Items
• Environments
• Publishing

Requirements

• node >= v10.16.3

Getting Started

Setup the project:

$ yarn setup && yarn build

Start all everything

$ yarn start

Available Scripts

Generate Library Items

In order to generate a new stencil component:

$ wcg --cmd generate --type component --name <component-name>

To generate an example for a component:

$ wcg --cmd generate --type example --name <component-name> --exampleName <example-name> --playbookDir <playbook-group-name>

After Generating a new component or an example remember to run a new build:

$ yarn build

Environments

Publishing

Update package versions

To change the version number in all package.json files, in the root directory, run the following command, replacing <update_type> with one of the semantic versioning release types (patch, major, or minor)

$ node bin/release <update_type>

Build all libraries and docs:

$ yarn build

Publish all packages:

$ node bin/publish

Commit and push the changes:

git add .
git commit -m "Release <version>"
git push