Skip to content

GreenTeaCake/gtc-components

Repository files navigation

Web Components Library

Component documentation:

The generated Storybook site also provides for the components the auto-generated documentation, interactive playground and accessibilty tests.

Build Flow

Pre-requisites

There is .nvmrc so you can go like this:

# in workspace root
$ nvm use

Build and Check Code

# go to workspace root
$ cd <workspace_root>

# install dependencies
$ npm install

# (optional) lint code
$ npm run lint

# (optional) format code
$ npm run format

# (optional) run tests
$ npm run test

# build the code
$ npm run build

# start dev environment at http://localhost:3333/
$ npm run build && npm run start

# start storybook (in dev mode) at http://localhost:6006/
$ npm run build && npm run storybook

# build storybook (in static mode to deploy)
$ npm run build && npm run storybook:build

# serve storybook (in static mode) at http://localhost:3000/
$ npm run build && npm run storybook:build && npm run storybook:serve