generator-jhipster-search-filter
v0.1.1
Published
A jhipster blueprint to search entities by query filter string
Downloads
7
Maintainers
Readme
generator-jhipster-search-filter
JHipster blueprint, A jhipster blueprint to search entities by query filter string
Uses the elasticsearch frontend search bar, but querying the backend using the jpaMetamodelFiltering
syntax.
Type name.contains=jhipster
in the search bar of your blog view, all the blogs whose name contains the jhipster
word will be displayed.
Experimental blueprint, now working only with React frontend.
Introduction
This is a JHipster blueprint, that is meant to be used in a JHipster application.
Prerequisites
As this is a JHipster blueprint, we expect you have JHipster and its related tools already installed:
Installation
With NPM
To install this blueprint:
npm install -g generator-jhipster-search-filter
To update this blueprint:
npm update -g generator-jhipster-search-filter
With Yarn
To install this blueprint:
yarn global add generator-jhipster-search-filter
To update this blueprint:
yarn global upgrade generator-jhipster-search-filter
Usage
To use this blueprint, run the below command
jhipster --blueprint search-filter
Running local Blueprint version for development
During development of blueprint, please note the below steps. They are very important.
- 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 search-filter
npm link
- 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 search-filter
npm link generator-jhipster
- 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-search-filter
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)
jhipster -d --blueprint search-filter
License
Apache-2.0 © Enrico Costanzi