Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 3.68 KB

README.md

File metadata and controls

105 lines (67 loc) · 3.68 KB
Raw

NPM version Build Status

JHipster blueprint,

generator-jhipster-entando

For more information and documentation visit: https://dev.entando.org, or https://forum.entando.org. Or for the latest news or product information please visit the main website: https://www.entando.com.

Information below is for running locally or building from source. For usage information see the links above.

Introduction

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

Prerequisites

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

Installation

With NPM

To install this blueprint:

npm install -g generator-jhipster-entando

To update this blueprint:

npm update -g generator-jhipster-entando

With Yarn

To install this blueprint:

yarn global add generator-jhipster-entando

To update this blueprint:

yarn global upgrade generator-jhipster-entando

Usage

To use this blueprint, run the below command

jhipster --blueprints entando

Running local Blueprint version for development

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

  1. 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.

git clone https://github.com/entando/generator-jhipster-entando.git
cd generator-jhipster-entando
npm link
  1. 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 generator-jhipster-entando
npm link generator-jhipster
  1. 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-entando
npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version)

jhipster -d --blueprints entando

Consuming API

Once you have generated a microservice, you can start it using ./mvnw. Swagger UI is automatically enabled in order to ease the API development process. At the end of the startup process, you will see a URL in the console. Opening it in a browser will show you some links, one of them is the Swagger UI one. Swagger UI comes configured out of the box, the only thing you have to ensure is that your keycloak instance is already started as illustrated here. When you try to authenticate in the Swagger UI you should keep prefilled data (swagger_ui/swagger_ui). After clicking Authorize, the first time you will be redirected to the Keycloak login form. There you have to login with credential admin/admin and you will be redirected back to the Swagger UI page.