Skip to content

yeoman-projects/generator-jhipster-electron

 
 

Repository files navigation

generator-jhipster-electron

NPM version Build Status Dependency Status Downloads       

A jhipster module to run spring boot jar app in electron package. It is the jhipster module version of the yeoman generator-electron-war-package

Please donate whether you wish support us to give more time to app's growth

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. You can use it to generate an electron exe that runs your target/*.jar package.

Notes

For the features of the last release refers to CHANGELOG.md.

Latest release news

[1.1.0] Release - 04-02-2020

  • Upgrade for jhipster 6.x to use jar instead of war

Prerequisites

As this is a JHipster module, we expect you to have an existing JHipster app with its prerequisites.

Or simply:

npm i -g generator-jhipster

Installation

With Yarn

To install this module:

yarn global add generator-jhipster-electron

To update this module:

yarn global upgrade generator-jhipster-electron

With NPM

To install this module:

npm install -g generator-jhipster-electron

To update this module:

npm update -g generator-jhipster-electron

Usage

Create a JHipster app using yo jhipster, or a backend-only with yo jhipster:server.

In the base directory of your JHipster app, run this module. This will create an electron-app folder that packages your jar in exe.

yo jhipster-electron

It will be created a folder named electron-jar-package. After installing dependencies and generating target/*.jar with spring-boot, you can run in this:

  • npm start : it runs the app in a live electron process
  • npm package : it creates an electron-jar 1.0.0.exe app in electron-jar-package/distribution

For both, you can read the backend log into the electron window using F1 keyword:

Electron-Log

The default port used in spring boot, called from the electron app, is 8081. You can change it in the electron.app.config.json

Contributing

Please read our guidelines before submitting an issue. For feature requests, bugs and queries you can use this template.

License

Apache-2.0 © amanganiello90

About

A jhipster module to run spring boot war app in electron package

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • JavaScript 73.1%
  • HTML 26.9%