Qlue UI Kit

Prolog

First of all we started creating atomic design, for further reading you can follow this original course CLICK HERE, the outline is please make sure your new component is corresponding to target of Atomic Design which are atoms, molecules and so on.

Quick Start

How to include this UI-kit with your awesome project

1. Run command yarn lerna add @qlue/ui-kit --scope @qlue/you-new-project
2. And then in your root component wrap with the Provider QlueUIProvider

import React from "react";
import ReactDOm from "react-dom";
import { QlueUIProvider } from "@qlue/ui-kit";

function Root() {
  return (
    <QlueUIProvider configName="CRMDashboard">
      <App />
    </QlueUIProvider>
  );
}

ReactDOM.render(<Root />, document.getElementById("root"));

3. And then corresponding configName what you want, if want to create new color, updated a config in variables.js and then if you want to use existing color project just fill in with project name in accordance with the variables.js file.

How to Contribute

The simple if you want to contribute to this repo

1. Fork the repository
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push -u origin my-new-feature
5. Create a Pull Request!