generator-jhipster-primeng-charts/README.md

Generate sample charts with PrimeNG

# generator-jhipster-primeng-charts
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> JHipster module, Generate sample charts with PrimeNG

<div align="center">
  <a href="http://jhipster.github.io">
    <img src="https://raw.githubusercontent.com/jhipster/jhipster.github.io/master/images/logo/logo-jhipster.png">
  </a>
  <a href="https://www.primefaces.org/primeng">
    <img width=120px src="https://pbs.twimg.com/profile_images/782907169414979584/i2fYktgo.jpg">
  </a>
</div>


# Introduction

This is a [JHipster](http://jhipster.github.io/) module, that is meant to be used in a JHipster application.

The minimum required version of JHipster is **>=5.1.0**.

This module is used to generate some charts, using [PrimeNG](https://www.primefaces.org/primeng).
See the official documentation here: https://www.primefaces.org/primeng/#/chart

The generated charts comes directly from PrimeNG:
- [BarChart](https://www.primefaces.org/primeng/#/chart/bar)
- [DoughnutChart](https://www.primefaces.org/primeng/#/chart/doughnut)
- [LineChart](https://www.primefaces.org/primeng/#/chart/line)
- [PieChart](https://www.primefaces.org/primeng/#/chart/pie)
- [PolarAreaChart](https://www.primefaces.org/primeng/#/chart/polararea)
- [RadarChart](https://www.primefaces.org/primeng/#/chart/radar)

<div align="center">
    <img src="https://raw.githubusercontent.com/pascalgrimaud/generator-jhipster-primeng-charts/master/images/generator-jhipster-primeng-charts.gif">
</div>


# Prerequisites

As this is a [JHipster](http://jhipster.github.io/) module, we expect you have JHipster and its related tools already installed:

- [Installing JHipster](https://jhipster.github.io/installation.html)

# Installation

## With Yarn

To install this module:

```bash
yarn global add generator-jhipster-primeng-charts
```

To update this module:

```bash
yarn global upgrade generator-jhipster-primeng-charts
```

## With NPM

To install this module:

```bash
npm install -g generator-jhipster-primeng-charts
```

To update this module:

```bash
npm update -g generator-jhipster-primeng-charts
```

# Usage

In your JHipster project, launch `yo jhipster-primeng-charts` and confirm.


# License

Apache-2.0 © [Pascal Grimaud](https://twitter.com/pascalgrimaud)


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