Overview:
generator-jhipster-nodejs is the official NodeJS blueprint that utilizes NestJS TypeScript Framework for the backend of your JHipster application. It provides a base app with web controllers, swagger doc, and JWT or OAuth2 passport auth services. The project is designed to generate all TypeScript files for the backend, excluding Java files.
Features:
- NestJS Framework: Utilizes the NestJS TypeScript Framework for backend development.
- Web Controllers and Swagger Documentation: Includes web controllers for easy routing and swagger documentation.
- JWT or OAuth2 authentication: Provides authentication services using JWT or OAuth2 passport services.
- Seed Users: Starts with four seed users - admin, basic user, and anonymous roles.
- Database Options: Supports SQLite for dev and customizable SQL database for prod. Mongodb is available from the 1.5.0 release.
- TypeORM Integration: Uses TypeORM for database migration and versioning.
- Client Options: Full stack app includes Angular/React client with customizable home page and CRUD operations for entities.
Installation:
To install with NPM:
- Install:
npm install -g generator-jhipster-nodejs
- Generate application:
nhipster
To update with NPM:
- Update installation:
npm update -g generator-jhipster-nodejs
To install with Yarn:
- Install:
yarn global add generator-jhipster-nodejs
- Generate application:
nhipster
To update with Yarn:
- Update installation:
yarn upgrade generator-jhipster-nodejs
Summary:
generator-jhipster-nodejs is a powerful NodeJS blueprint that seamlessly integrates with JHipster applications, providing a robust backend solution based on the NestJS TypeScript Framework. With features like web controllers, authentication services, and database options, developers can quickly set up a full stack application with CRUD operations for entities. The installation process is straightforward, making it easy for developers to get started with building NodeJS backends for their JHipster applications.