# generator-jhipster-react-mobx

[![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url]

![Generator](https://github.com/erkieh/generator-jhipster-react-mobx/workflows/Generator/badge.svg) ![React](https://github.com/erkieh/generator-jhipster-react-mobx/workflows/React/badge.svg)

> JHipster blueprint, React blueprint with Mobx for state management

# Introduction

This is a [JHipster](https://www.jhipster.tech/) blueprint, that is meant to be used in a JHipster application to generate a React web application with Mobx for state management

# Prerequisites

As this is a [JHipster](https://www.jhipster.tech/) blueprint, we expect you have JHipster and its related tools already installed:

- [Installing JHipster](https://www.jhipster.tech/installation/)

# Installation

## With NPM

To install this blueprint:

```bash
npm install -g generator-jhipster-react-mobx
```

To update this blueprint:

```bash
npm update -g generator-jhipster-react-mobx
```

## With Yarn

To install this blueprint:

```bash
yarn global add generator-jhipster-react-mobx
```

To update this blueprint:

```bash
yarn global upgrade generator-jhipster-react-mobx
```

# Usage

To use this blueprint, run the below command

```bash
jhipster --blueprint react-mobx
```

## Running local Blueprint version for development

During development of blueprint, please note the below steps. They are very important.

1. Link your blueprint globally

Note: If you do not want to link the blueprint(step 3) to each project being created, use NPM instead of Yarn as yeoman doesn't seem to fetch globally linked Yarn modules. On the other hand, this means you have to use NPM in all the below steps as well.

```bash
cd generator-jhipster-react-mobx
npm link
```

2. Link a development version of JHipster to your blueprint (optional: required only if you want to use a non-released JHipster version, like the master branch or your own custom fork)

You could also use Yarn for this if you prefer

```bash
cd generator-jhipster
npm link

cd generator-jhipster-react-mobx
npm link generator-jhipster
```

3. Create a new folder for the app to be generated and link JHipster and your blueprint there

```bash
mkdir my-app && cd my-app

npm link generator-jhipster-react-mobx
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)

jhipster -d --blueprint generator-jhipster-react-mobx

```

# License

Apache-2.0 © [Erki Ehtla](https://github.com/erkieh)

[npm-image]: https://img.shields.io/npm/v/generator-jhipster-react-mobx.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-react-mobx
[daviddm-image]: https://david-dm.org/erkieh/generator-jhipster-react-mobx.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/erkieh/generator-jhipster-react-mobx