# mjh-framework

> Foundation Framework

[![NPM](https://img.shields.io/npm/v/mjh-framework.svg)](https://www.npmjs.com/package/mjh-framework) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save @mjhls/mjh-framework
```

## Usage

```jsx
import React, { Component } from 'react'

import { NavMagazine, DeckQueue } from 'mjh-framework'

export default class App extends Component {
  render() {
    return (
      <div>
        <NavMagazine />
        <DeckQueue />
      </div>
    )
  }
}
```

## Publish new updates to the npm registry

```bash
npm publish
```

## For getting updates in the template without publishing each time a change is made in the framework

Link react and react-dom of the template repo, so that it can be used by the framework.
This is to avoid the error arising due to multiple instances of React.

```bash
cd mjh-template/node_modules/react

yarn link

cd ../react-dom

yarn link

cd ../../../mjh-framework

yarn link react && yarn link react-dom
```

Link the framework repo so that it can be used in the template

```bash
npm link

cd ../mjh-template

npm link @mjhls/mjh-framework
```


## License

MIT © [mjh-framework](https://github.com/mjh-framework)
