konstellation-web-components

Component library for Konstellation projects

Install

npm install --save kwc

or

yarn add kwc

Usage

Add styles at the index of your website

import 'kwc/dist/index.css';

You can now import the components directly from the library

import React from 'react'

import { Button } from 'kwc'

function Example() {
  render() {
    return <Button />
  }
}

Docz local deployment

In case you want to deploy the documentation site for this project you first need to install the dependencies:

yarn install

or

npm install

And then you can deploy the docs by executing this command:

yarn docz dev

or

npm run docz dev

Development

To develop or update KWC components we need to follow the next steps:

1 - live build the package

Go to kwc/packages/konstellation-web-components and start the live build script:

yarn live-build

2 - link kwc package

In the same directory link the package:

yarn link

3 - link the package to teh dev environment

Go to the dev environment kwc/dev-env and link the previous package:

yarn link kwc

4 - Start the dev env application

Start the application:

yarn start

Note: remember to install the dependencies first using yarn or yarn install

License

MIT © konstellation-io