Skip to content

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

License

Notifications You must be signed in to change notification settings

MaritzSTL/chameleon

Repository files navigation

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:

  • Node.js - JavaScript runtime built on Chrome's V8 JavaScript Engine (this project uses v12.7.0)
  • Git - Version control software for cloning this repository
  • NVM (Node Version Manager) - A bash script to manage multiple active node.js versions
  • Yarn - Package manager used for Yarn workspaces

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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published