Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ecostanzi/generator-jhipster-search-filter
https://github.com/ecostanzi/generator-jhipster-search-filter
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ecostanzi/generator-jhipster-search-filter
- Owner: ecostanzi
- License: apache-2.0
- Created: 2019-07-19T15:45:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T18:59:49.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T13:12:10.987Z (18 days ago)
- Language: HTML
- Size: 688 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-jhipster-search-filter
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> 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](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-search-filter
```
To update this blueprint:
```bash
npm update -g generator-jhipster-search-filter
```
## With Yarn
To install this blueprint:
```bash
yarn global add generator-jhipster-search-filter
```
To update this blueprint:
```bash
yarn global upgrade generator-jhipster-search-filter
```
# Usage
To use this blueprint, run the below command
```bash
jhipster --blueprint search-filter
```
## 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 search-filter
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 search-filter
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-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]()
[npm-image]: https://img.shields.io/npm/v/generator-jhipster-search-filter.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-search-filter
[travis-image]: https://travis-ci.org/ecostanzi/generator-jhipster-search-filter.svg?branch=master
[travis-url]: https://travis-ci.org/ecostanzi/generator-jhipster-search-filter
[daviddm-image]: https://david-dm.org/ecostanzi/generator-jhipster-search-filter.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/ecostanzi/generator-jhipster-search-filter