Generator-jhipster-skipserverweb NPM

generator-jhipster-skipserverweb

JHipster blueprint, Blueprint that allows for a Java web layer to be skiped during code generation.

Introduction

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

This blueprint is intended for applications/projects that would like to take benefit from JHippster generator capabilities in creating Java JPA model, DTO's, JPA Repositories and Service layer, but do not need Controllers, Mappers and other components specific for Web applications.

Examples of this kind of applications would be: Spring Shell CLI apps, or Java FX based Desktop applications.

In short once installed this bluprint will skip the generation of all web components.

What this blueprint does not do at the moment.

Current version of the bluprint does not change build files: gradle.build or pom.xml.

You still need to manually remove web dependencies you do not need from these!

Supported JHipster version

Current version of the JHipster generator this bluprint is adjusted for, is JHipster version 6.10.5.

Prerequisites

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

Installing JHipster

Installation

With NPM

To install this blueprint:

npm install -g generator-jhipster-skipserverweb

To update this blueprint:

npm update -g generator-jhipster-skipserverweb

With Yarn

To install this blueprint:

yarn global add generator-jhipster-skipserverweb

To update this blueprint:

yarn global upgrade generator-jhipster-skipserverweb

Usage

To use this blueprint in your Jhipster project run the command bellow:

jhipster --blueprint skipserverweb

Running local Blueprint version for development

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

Link your blueprint globally

Note: If you do not want to link the blueprint(step 3) to each project being created, use NPM instead of Yarn as yeoman doesn't seem to fetch globally linked Yarn modules. On the other hand, this means you have to use NPM in all the below steps as well.

cd generator-jhipster-skipserverweb
npm link

Link a 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)

You could also use Yarn for this if you prefer

cd generator-jhipster
npm link

cd skipserverweb
npm link generator-jhipster

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

jhipster -d --blueprint skipserverweb