generator-jhipster-angular-flex/README.md

This module extends the angular client side to provide flex layouts for every entity with generated material cards and list views for every entity. This module imports @angular/material to the vendor.scss file and modifies app.module.ts to include an angu

# generator-jhipster-angular-flex
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> JHipster blueprint, This module extends the angular client side to provide flex layouts for every entity with generated material cards and list views for every entity. This module imports @angular/material to the vendor.scss file and modifies app.module.ts to include an angular material module.

# Introduction

This is a [JHipster](https://www.jhipster.tech/) blueprint, that is meant to be used in a JHipster application.

# 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-angular-flex
```

To update this blueprint:

```bash
npm update -g generator-jhipster-angular-flex
```

## With Yarn

To install this blueprint:

```bash
yarn global add generator-jhipster-angular-flex
```

To update this blueprint:

```bash
yarn global upgrade generator-jhipster-angular-flex
```

# Usage

To use this blueprint, run the below command

```bash
jhipster --blueprint angular-flex
```


## 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 angular-flex
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 angular-flex
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-angular-flex
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)

jhipster -d --blueprint angular-flex

```

# License

MIT © [Rob Walls](www.detachedbrand.com)


[npm-image]: https://img.shields.io/npm/v/generator-jhipster-angular-flex.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-angular-flex
[travis-image]: https://travis-ci.org/robwalls3/generator-jhipster-angular-flex.svg?branch=master
[travis-url]: https://travis-ci.org/robwalls3/generator-jhipster-angular-flex
[daviddm-image]: https://david-dm.org/robwalls3/generator-jhipster-angular-flex.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/robwalls3/generator-jhipster-angular-flex