Registry / devops / generator-jhipster-grpc

generator-jhipster-grpc

library0.22.0jsnpmunverified

A JHipster module that adds support for gRPC and generates gRPC CRUD services for JHipster applications. Version 0.22.0 supports JHipster 6.4 and 6.5, but development appears to have stalled with no releases since 2019. It configures reactive-grpc and grpc-spring-boot-starter, compiles proto files from src/main/proto, and generates endpoints using Reactor (Flux) with back-pressure. Compared to manually adding gRPC, it integrates seamlessly into the JHipster workflow and supports entities, pagination, relationships, security (JWT, OAuth2, basic auth), ElasticSearch, and management endpoints. Limitations include requirement of a service layer for entities and no support for client-side configuration or streaming from DB.

devops

npm install generator-jhipster-grpc

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GENERATOR-JHIPSTER

generator-jhipster-grpc

devopsjavascriptv0.22.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generator

✓ npm install -g generator-jhipster-grpc

✗ npm install generator-jhipster-grpc (without -g)

Must be installed globally via npm install -g

usage

✓ yo jhipster-grpc

✗ jhipster-grpc or generator-jhipster-grpc

Use yo command after global install

Install JHipster and the gRPC module globally, create a JHipster app, then run the module to add gRPC support and generate CRUD services.

# Install JHipster and the module globally npm install -g generator-jhipster npm install -g generator-jhipster-grpc@0.22.0 # Create a JHipster application mkdir myapp && cd myapp jhipster # Run the gRPC module to add gRPC support and generate CRUD services for entities yo jhipster-grpc # Build and run the application (example with Maven) ./mvnw spring-boot:run # The gRPC server will be available on port 6565 by default. # You can test with grpcurl or generate a client from the proto files in src/main/proto.

Debug

Known issues

deprecatedNo release since 0.22.0 (2019); JHipster 7+ compatibility unknown.

fix

Consider alternatives like manually configuring gRPC or use JHipster's built-in support.

affects: >=0.22.0

breakingRequires JHipster 6.4 or 6.5; will not work with newer versions.

fix

Use a JHipster version between 6.4 and 6.5, or use an older module version for older JHipster.

affects: 0.22.0

gotchaEntities must have a service layer (serviceClass or serviceImpl) for gRPC generation.

fix

Ensure entities use serviceClass or serviceImpl when generating.

affects: >=0.0.0

gotchaEntities referenced by another entity in a relationship (many-to-many owned side, many-to-one, one-to-one owned side) must also be gRPC activated and have a service layer.

fix

Generate gRPC for all related entities with service layer.

affects: >=0.0.0

Errors

Common errors & fixes

Module not found: 'generator-jhipster-grpc'

Module not installed globally.

fix

Run 'npm install -g generator-jhipster-grpc'

Error: This module requires JHipster version X.X.X

Incompatible JHipster version.

fix

Install a compatible JHipster version or use an older module version.

Cannot find module 'generator-jhipster'

JHipster is not installed globally.

fix

Run 'npm install -g generator-jhipster'

Upgrade

Version history

0.22.0latest on npm

Audit

Dependencies

generator-jhipsterrequiredRequired as a dependency for JHipster modules; must be installed globally

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/cbornet/generator-jhipster-grpc ↗

packagegenerator-jhipster-grpc ↗

homepagehttps://github.com/cbornet/generator-jhipster-grpc ↗