generator-jhipster-quarkus

(β˜… 153)

Quarkus blueprint for JHipster

  • .editorconfig
  • .gitattributes
  • .gitignore
  • .prettierignore
  • .prettierrc.yml
  • .yo-rc.json
  • .yo-resolve
  • eslint.config.ts
  • LICENSE
  • NOTICE
  • package-lock.json
  • package.json
  • README.md
  • tsconfig.json
  • vitest.config.ts
  • vitest.test-setup.ts

# Installation Guide

1. Get the code
git clone https://github.com/jhipster/generator-jhipster-quarkus

Downloads the entire project code from GitHub to your computer.

cd generator-jhipster-quarkus

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g generator-jhipster-quarkus

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install -g jhipster/generator-jhipster-quarkus#main

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd generators/quarkus/resources

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd generators/quarkus/resources

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g generator-jhipster-quarkus

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install -g jhipster/generator-jhipster-quarkus#main

Installs the package published on the npm registry globally β€” no need to clone the source.

npm link

Type this command into your terminal and run it.

npm link generator-jhipster

Type this command into your terminal and run it.

npm link generator-jhipster-quarkus

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation