Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhipster/generator-jhipster-nodejs
A NodeJS blueprint that creates the backend using NestJS
https://github.com/jhipster/generator-jhipster-nodejs
angular generator jhipster nestjs-backend nodejs react vuejs yeoman-generator
Last synced: 1 day ago
JSON representation
A NodeJS blueprint that creates the backend using NestJS
- Host: GitHub
- URL: https://github.com/jhipster/generator-jhipster-nodejs
- Owner: jhipster
- License: apache-2.0
- Created: 2019-06-10T19:55:59.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T06:28:31.000Z (3 months ago)
- Last Synced: 2024-10-30T00:55:31.968Z (3 months ago)
- Topics: angular, generator, jhipster, nestjs-backend, nodejs, react, vuejs, yeoman-generator
- Language: EJS
- Homepage: https://www.npmjs.com/package/generator-jhipster-nodejs
- Size: 4.37 MB
- Stars: 257
- Watchers: 31
- Forks: 79
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# generator-jhipster-nodejs
[![NPM version][npm-image]][npm-url]
[![Generator Build Status][github-actions-generator-image]][github-actions-generator-link]
[![Generator Angular Samples Status][github-actions-angular-samples-image]][github-actions-angular-samples-link]
[![Generator React Samples Status][github-actions-react-samples-image]][github-actions-react-samples-link]
[![Generator Vue Samples Status][github-actions-vue-samples-image]][github-actions-vue-samples-link]
[![Generator Microservice Samples Status][github-actions-microservice-samples-image]][github-actions-microservice-samples-link]
[![Gitter][gitter-image]][gitter-url]
[![Downloads][npmcharts-image]][npmcharts-url]
> generator-jhipster-nodejs, the _official NodeJS blueprint_ that uses [NestJS TypeScript Framework](https://nestjs.com/) for your **backend**. We encourage you to use it and give us your feedback.
> ## Notes
>
> For the features of the last release refers to [CHANGELOG.md](https://github.com/jhipster/generator-jhipster-nodejs/tree/v2.0.0/CHANGELOG.md).
> ## Demo
>
> The UI is inherited from standard JHipster app client. So only backend generation changes.
> For this, a live app running is less useful than the code and the app structure shows in:
>
> - **The sample repo app with** [React client and Okta OAuth2](https://github.com/jhipster/jhipster-sample-app-nodejs-oauth2/tree/v2.0.0)
> - **The sample repo app with** [Angular client and JWT auth](https://github.com/jhipster/jhipster-sample-app-nodejs/tree/v2.0.0)
> - **The sample repo app with** [Vue.js client and mongodb](https://github.com/jhipster/jhipster-sample-app-nodejs-vuejs/tree/v2.0.0)
# Greetings, nodejs Hipster!
This project adds nodejs for your backend, **all TypeScript files generation, not Java!**, to the [JHipster](https://www.jhipster.tech/) application 😎. It is based on JHipster Blueprint 🔵, that is meant to be used in a JHipster application.
> The generator applies this standard configuration for the NodeJS app:
> - NestJS base app with web controllers, [swagger doc](https://github.com/nestjs/swagger) and [JWT or OAuth2 passport auth](https://github.com/nestjs/passport) services
> - The app starts with four seed users (admin, basic user and anonymous roles), as standard JHipster monolithic app, with SQLite for dev and configurable sql db for prod. MongoDB support is experimental in [TypeORM](https://github.com/typeorm/typeorm/blob/fdbb013d2279264e851dacc4c5c2e94567b65ab7/README.md?plain=1#L255) so is in JHipster NodeJS.
> - The app uses [TypeORM](https://github.com/nestjs/typeorm) and asks you a question for another sql db or for mongodb
> - TypeORM is also used for the automatically migration and versioning of the database scripts
> - The app runs also as a full stack app including, for the monolitich choice, the Angular/React client with the home page set for NHipster and CRUD operations for entity generated with subgenerator and jdl import
> A **previous of a jwt auth app:**
# 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/)
- [node.js 14.16.0](https://nodejs.org/de/blog/release/v14.16.0/)
**Please attention to install that node.js version!!**
# 🚀 How to get started
1. Make sure you have followed the [JHipster installation guide](https://www.jhipster.tech/installation) and that both `yeoman` and `jhipster` are installed.
2. Install the package with `npm install -g generator-jhipster-nodejs`
3. And generate the application with `nhipster`
# Installation Details
## With NPM
To install this blueprint:
```bash
npm install -g generator-jhipster-nodejs
```
To update this blueprint:
```bash
npm update -g generator-jhipster-nodejs
```
## With Yarn
To install this blueprint:
```
yarn global add generator-jhipster-nodejs
```
To update this blueprint:
```bash
yarn global upgrade generator-jhipster-nodejs
```
## 🚦 What we have now
This is a blueprint that is runnable by:
```bash
nhipster
```
However, it also ships with an `nhipster` CLI that you can use as a shortcut.
✅ General App generation
- `nhipster`
✅ JDL model support generation
- `nhipster jdl my_file.jdl`
✅ Ci-cd generation
- `nhipster ci-cd`
For the last, in the [generate-sample samples folder](https://github.com/jhipster/generator-jhipster-nodejs/tree/main/.blueprint/generate-sample/templates/samples) and [jdl-samples](https://github.com/jhipster/jdl-samples) there are some examples of jdl models.
## Using Docker
1. Download the Dockerfile:
```bash
mkdir docker
cd docker
wget https://github.com/jhipster/generator-jhipster-nodejs/raw/master/docker/Dockerfile
```
2. Build the Docker images:
```bash
docker build -t jhipster-generator-nodejs:latest .
```
3. Make a folder where you want to generate the Application:
```bash
mkdir app
cd app
```
4. Run the generator image in one of the two following options.
- Run the generator from image to generate service:
```bash
docker run -it --rm -v $PWD:/home/jhipster/app jhipster-generator-nodejs
```
- Run and attach interactive shell to the generator docker container to work from inside the running container:
```bash
docker run -it --rm -v $PWD:/home/jhipster/app jhipster-generator-nodejs /bin/bash
```
## 🛠 Steps to develop a generator feature and test it
Shell steps:
```console
$ git clone https://github.com/jhipster/generator-jhipster-nodejs.git
$ cd generator-jhipster-nodejs
$ git checkout -b feature/my-feature
$ npm install
$ npm link
$ cd ..
$ mkdir test-generation
$ cd test-generation
```
Now you will develop under the **generator-jhipster-nodejs** that you have cloned with git.
After finish, to generate the app and check your feature, run in **test-generation** folder:
- `nhipster`
## ❤️ For community
Found an [issue](https://github.com/jhipster/generator-jhipster-nodejs/issues), check if is already opened or closed, otherwise open a new [feature or bug](https://github.com/jhipster/generator-jhipster-nodejs/issues/new/choose).
Interested in contributing, check out our [contributing guide](https://github.com/jhipster/generator-jhipster-nodejs/blob/master/CONTRIBUTING.md) to get started.
Refer for contribution to [roadmap](https://github.com/jhipster/generator-jhipster-nodejs/blob/master/ROADMAP.md) or to [kanban board](https://github.com/jhipster/generator-jhipster-nodejs/projects/1?fullscreen=true).
Any questions [Angelo Manganiello](mailto:[email protected]).
# Contributors ✨
Thanks goes to these wonderful people:
Angelo Manganiello
(founder stream lead)
Hadi Rasouli
Iván García Sainz-Aja
Daniel Franco
Ed Pham
Markus
# Special Thanks
# License
Apache-2.0 © [Angelo Manganiello](https://github.com/amanganiello90)
[npm-image]: https://img.shields.io/npm/v/generator-jhipster-nodejs.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-nodejs
[github-actions-generator-image]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/generator.yml/badge.svg
[github-actions-generator-link]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/generator.yml
[github-actions-angular-samples-image]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-angular.yml/badge.svg
[github-actions-angular-samples-link]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-angular.yml
[github-actions-react-samples-image]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-react.yml/badge.svg
[github-actions-react-samples-link]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-react.yml
[github-actions-vue-samples-image]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-vue.yml/badge.svg
[github-actions-vue-samples-link]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-vue.yml
[github-actions-microservice-samples-image]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-microservice.yml/badge.svg
[github-actions-microservice-samples-link]: https://github.com/jhipster/generator-jhipster-nodejs/actions/workflows/test-integration-microservice.yml
[github-actions-url]: https://github.com/jhipster/generator-jhipster-nodejs/actions
[sonar-url]: https://sonarcloud.io/dashboard?branch=main&id=jhipster_generator-jhipster-nodejs
[sonar-coverage-url]: https://sonarcloud.io/component_measures?branch=main&id=jhipster_generator-jhipster-nodejs&metric=coverage&view=list
[sonar-gate-image]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=jhipster_generator-jhipster-nodejs&metric=alert_status
[sonar-coverage-image]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=jhipster_generator-jhipster-nodejs&metric=coverage
[sonar-reliability-image]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=jhipster_generator-jhipster-nodejs&metric=reliability_rating
[sonar-security-image]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=jhipster_generator-jhipster-nodejs&metric=security_rating
[sonar-maintainability-image]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=jhipster_generator-jhipster-nodejs&metric=sqale_rating
[sonar-duplication-image]: https://sonarcloud.io/api/project_badges/measure?branch=main&project=jhipster_generator-jhipster-nodejs&metric=duplicated_lines_density
[daviddm-image]: https://david-dm.org/jhipster/generator-jhipster-nodejs.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/jhipster/generator-jhipster-nodejs
[npmcharts-image]: https://img.shields.io/npm/dm/generator-jhipster-nodejs.svg?label=Downloads&style=flat
[npmcharts-url]: https://npmcharts.com/compare/generator-jhipster-nodejs
[gitter-image]: https://badges.gitter.im/generator-jhipster-nodejs/community.svg
[gitter-url]: https://gitter.im/generator-jhipster-nodejs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge