MaritzSTL / chameleon

Chameleon Web Components - A collection of lightweight, unidirectional, framework-agnostic elements based on the Chameleon Design System
https://chameleon-design-system.netlify.app
MIT License
27 stars 7 forks source link
design-system lit-element lit-html webcomponents

Netlify Status CircleCI codecov

Chameleon Web Components

export default {
  title: "Intro|Chameleon Web Components",
  options: { selectedPanel: "storybookjs/docs/panel" },
};

Chameleon Web Components - A collection of lightweight, unidirectional, framework-agnostic elements based on the Chameleon Design System.

Prerequisites

The Chameleon project relies on some awesome tools in order to work properly. You'll want to have the following installed:

Setup

Note: Please ensure you have all the prerequisite software installed before running any of these commands!

To setup Chameleon for development, run the following in your folder of choice:

git clone git@github.com:MaritzSTL/chameleon.git && cd chameleon && nvm use && yarn setup

Chameleon uses storybook for development, so when you're ready to get going just run:

yarn dev

To build each element and package for distribution, run:

yarn build

If something looks wrong or you need to refresh your dependencies for whatever reason you can run:

yarn clean