Skip to content

jhipster/generator-jhipster-quarkus

JHipster Quarkus Blueprint

NPM version Generator CI Imperative Smoke Tests

JHipster Quarkus Family Member

Introduction

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

Demo

Because a code worth a 1k words here your have sample JHipster Quarkus repositories

Prerequisites

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

Installation

To install or update this blueprint:

npm install -g generator-jhipster-quarkus

Usage

To use this blueprint, run the command below:

jhipster-quarkus

Or, you can use:

jhipster --blueprints quarkus

You can look for updated quarkus blueprint specific options by running

jhipster app --blueprints quarkus --help

And looking for (blueprint option: quarkus) like

Pre-release

To use an unreleased version, install it using git.

npm install -g jhipster/generator-jhipster-quarkus#main
jhipster --blueprints quarkus --skip-jhipster-dependencies

🚦 Blueprint features:

✅ Generate App generation: jhipster-quarkus

✅ Entity generation: jhipster-quarkus entity <entity-name>

✅ JDL import: jhipster-quarkus jdl sample.jh

❤️ for community

Interested in contributing? Check out JHipster contributing guide to get started.

Running local Blueprint version for development

During development of blueprint, please note the below steps. They are very important.

  1. Link your blueprint globally

    cd generator-jhipster-quarkus
    npm link
    
  2. Link the 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)

    cd generator-jhipster
    npm link
    
    cd quarkus
    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-quarkus
    npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)
    
    npx jhipster-quarkus
    

License

Apache 2.0, see LICENSE.