wgk-ui v1.0.2

WGK UI

A WGK flavoured component library.

Table of contents

• Getting started
  • Prerequisites
  • Installation
  • Development
  • Build
• Testing
• Linting
• Links

Getting started

Prerequisites

• Node.js

Installation

• Install all dependencies by running npm install.

Development

• Follow CONTRIBUTING.md.
• Use npm run storybook to run Storybook.
• Browse to https://localhost:6006.

Build

• Use npm run build to build the application on your local machine.

Testing

• Use npm run test:unit to run all unit tests (Jest).
• Use npm run test:component to run all component tests (Cypress).

Linting

• Use npm run lint:fix to lint all your TypeScript files.

Links

• Design system in Figma