nazifsohtaoglu / jhipster-primereact-blueprint

This is a blueprint for create jhipster application using primereact as Client UI Framework

Jhipster Primereact Blueprint

Introduction

This project adds Primereact to the JHipster React application. It is based on JHipster Blueprint

This is a JHipster blueprint, that is meant to be used in a JHipster application.

Features

• Filtering is enabled by setting the filter property in entity.
• Pagination is enabled by setting paginator property in entity
• Lazy mode is enabled by default, instead of loading the entire data, small chunks of data is loaded by invoking corresponding callbacks everytime paging, sorting and filtering happens.

• Only primereact Framework is supported.

- 8 different themes are supprted.

Prerequisites

As this is a JHipster blueprint, we expect you have JHipster and its related tools already installed:

• Installing JHipster

Installation

With NPM

To install this blueprint:

npm install -g generator-jhipster-primereact-blueprint

To update this blueprint:

npm update -g generator-jhipster-primereact-blueprint

With Yarn

To install this blueprint:

yarn global add generator-jhipster-primereact-blueprint

To update this blueprint:

yarn global upgrade generator-jhipster-primereact-blueprint

Usage

To use this blueprint, run the below command

jhipster --blueprint primereact-blueprint

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.

cd primereact-blueprint
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

cd generator-jhipster
npm link

cd primereact-blueprint
npm link generator-jhipster

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

mkdir my-app && cd my-app

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

jhipster -d --blueprint primereact-blueprint

License

MIT © Jhon Eder Portocarrero