generator-jhipster README

The project's README from github.com/jhipster/generator-jhipster. As one markdown file: README.md.

Logo

NPM version Downloads Gitter Known Vulnerabilities Package Health

Generator Build Status Angular Build Status React Build Status Vue Build Status Revved up by Develocity

Greetings, Java Hipster!

Full documentation and information is available on our website at https://www.jhipster.tech.

Please read our guidelines before submitting an issue. If your issue is a bug, please use the bug template pre-populated here. For feature requests and queries you can use this template. If you have found a potential security issue, please read our security policy and contact us privately first: https://github.com/jhipster/generator-jhipster/security/policy

Contributing

We are honored by any contributions you may have small or large. Please refer to our contribution guidelines and instructions document for any information about contributing to the project.

Supported Java and Node versions

The following Java and Node combinations are tested and verified by GitHub Actions:

Java Node Status
21/25 22/24 ✅

Sponsors

Support this project by becoming a sponsor! Become a sponsor or learn more about sponsoring the project.

Thank you to our sponsors!

Gold sponsors

GoldSponsors

Bronze sponsors

BronzeSponsors

Backers

Thank you to all our backers!

Backers

Daily Builds

Additional builds at hipster-labs/jhipster-daily-builds

Pipeline Status
Angular Maven SQL
Angular Maven NoSQL
Angular Gradle SQL
Angular Gradle NoSQL
React Maven SQL
React Maven NoSQL
React Gradle SQL
React Gradle NoSQL
Vue Maven SQL
Vue Maven NoSQL
Vue Gradle SQL
Vue Gradle NoSQL
Elasticsearch
Monolith OAuth 2.0
No Database
Microservices JWT
Microservices OAuth 2.0
Docker Image
Official Windows

Analysis of the sample JHipster project

sonar-quality-gate sonar-coverage sonar-bugs sonar-vulnerabilities sonar-sample-code-smells-badge

generator-jhipster (jhipster/generator-jhipster)

Searching Database…

What is this?An open-source development platform for quickly generating, developing, and deploying modern web applications and microservice architectures: you answer its prompts, and it hands you a complete full-stack codebase.
So is it a framework I code against, or something else?It is a code generator you run from the command line, not a framework you import: built on Yeoman, it scaffolds a project once — a Spring Boot backend with an Angular, React, or Vue frontend — and the generated code is yours to maintain.
How do I get it running?Install it globally with npm ('npm install -g generator-jhipster'), then run 'jhipster' in an empty directory and answer its prompts; the full installation docs are on the project website.
What do I need to have installed first?The generator itself needs Node.js 22 or 24 with npm 10 or newer, and the apps it generates target Java 21 or 25 — these Java/Node pairs are exactly what the project's CI tests.
Is it just for monolithic apps, or does it handle microservices too?Both are covered: besides monoliths it can scaffold microservice architectures, and CI pipelines verify microservice setups secured with JWT or OAuth 2.0.
Who is JHipster actually for?Primarily Java developers — the README greets you with 'Greetings, Java Hipster!' — who want a Spring Boot backend plus a modern JavaScript frontend without wiring everything by hand.
Will it run on Windows, or is it a Mac and Linux thing?It runs anywhere Node.js runs — Windows, macOS, and Linux — and the project even maintains an 'Official Windows' CI pipeline for it.
Which frontend, build tool, and database combos does it support?Daily CI exercises a wide matrix: Angular, React, and Vue frontends, each built with Maven or Gradle over SQL or NoSQL databases — plus an Elasticsearch integration and even a no-database option.
Can it deploy what it generates?Yes: its CI produces a Docker image, and Docker plus Kubernetes support are core parts of the platform, so container and cloud deployment are first-class.
How mature and active is the project?Very: created in 2013, around 22,500 GitHub stars, with extra daily builds at hipster-labs/jhipster-daily-builds, a SonarCloud quality dashboard for its sample app, and Hacktoberfest participation.
What are similar projects?angular-cli, yeoman, razzle, jib, create-t3-app, nx, mall-swarm, mitosis
Creator
jhipster
Size
195.1 MB
Stars
22.5K
Age
12y
Commits · 90 Days