@makeen.io/material-ui-kit/README.md

Makeen UI components kit. Based on material-ui.

# Makeen UI KIT

## Usage guide

### Installation

If you want to consume latest published version in npm - you can just run

`npm i --save @makeen.io/material-ui-kit`

or

`yarn add @makeen.io/material-ui-kit`

That`s it, now you can start using it.

### Basic setup

To get started you need to create `ThemeProvider` and provide default theme you will be using:

---

... here comes the code

---

## Contribution guide

When it comes to usage, most probably you will need to extend the functionality somehow. There are two approaches to do it:

1. You do local changes that affect only your project or component. That changes most probably wont appear in other projects that consume this UI-kit.
2. You want to contribute to this UI-kit for any purpose.

If it`s the first - just override styles/behavior locally, thats fine. (But I think its quite rare case);

When it comes to contribution, there are following steps needs to be done to make everything working:

### Installation

Installation process is same, move on)

### Local development (this project)

You will need to install **yalc** globally: `yarn global add yalc`

When you make some local changes, make sure your code is extendable, have backwards compatibility if you change something in existing codebase and have storybook and docs, explaining how to use your code.

When you have something ready, just run:

`yarn publish:local`

This command will make local version of the package you will be able to use in projects

### Local development (dependent project)

When you make changes, you obviously need to see changes you made in the project you`re working on, or some sample project.

Run `yalc add @makeen.io/material-ui-kit`

to install local version of the package you published in previous step.

Now you probably will need to restart the project and see changes.

Then you can repeat this steps as much as you need and .

### Publishing

When you are ready to publish changes in npm registry, you should create new branch here, make PR on GitHub, which will be merged and then published to the remote registry.