/generator-jhipster-ngxadmin

A JHipster blueprint that adds the ngx-admin v8.0.0 app template

Primary LanguageTypeScript

generator-jhipster-ngxadmin

JHipster blueprint for ngx-admin app template

NPM version Generator Integration Test

Introduction

This is a JHipster blueprint, that is meant to be used in a JHipster application. It adds an angular client with the ngx-admin v8.0.0 template, inheriting standard prompt but with the following options customization:

  • Only monolith or gateway chooices
  • Only security oauth2
  • Without client test frameworks
  • Without client options (angular ngx template is applied in any case)
  • Applied alwayis admin UI

Prerequisites

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

Please attention that it is tested for JHipster v7.8.1, running generated app with maven

Installation

To install or update this blueprint:

npm install -g generator-jhipster-ngxadmin

Development

To contribute and test locally the blueprint, After download this repo, execute on root folder:

npm link

Then create out of this repo an empty folder, in order to run the generation:

npm link generator-jhipster-ngxadmin

Usage

To use this blueprint, run the below command

jhipster --blueprints ngxadmin

You can look for updated ngxadmin blueprint specific options by running

jhipster app --blueprints ngxadmin --help

And looking for (blueprint option: ngxadmin) like.

However, it also ships with an jhipster-ngxadmin CLI that you can use as a shortcut.

General App generation

  • jhipster-ngxadmin

Entity generation

  • jhipster-ngxadmin entity <entity-name>

JDL Entity model support generation

  • jhipster-ngxadmin import-jdl <my-file.jdl>

Besides, you can also run the blueprint on a standard jhipster app, because it will regenerate the project adding the ngx template and configuration.

To update, run the basic command jhipster-ngxadmin.

Pre-release

To use an unreleased version, install it using git.

npm install -g jhipster/generator-jhipster-ngxadmin#main
jhipster --blueprints ngxadmin --skip-jhipster-dependencies

To DO:

  • Support more options (no fixed questions on security, admin UI, and so on)

License

Apache-2.0 © Angelo Manganiello