JHipster virtualized development box
Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

JHipster official "development box"

Introduction

This is a Vagrant configuration to set up a complete, virtualized development environment for JHipster users.

  1. Usage
  2. Installation
  3. Customize your virtual machine
  4. Configure your new box and install new software

Usage

The JHipster "development box" is a complete development environment for JHipster users.

It requires to have Vagrant installed on your machine.

It is fully based on Open Source software, most importantly:

  • Ubuntu
  • OpenJDK (Oracle JDK can't be used because of license issues)
  • Yarn, NPM, Bower and Gulp
  • Docker and Docker Compose (see the JHipster Docker Compose documentation to learn how to run your application, database or even a full micro-service architecture with Docker)
  • Ubuntu Make so you can easily install your favorite IDE (type umake ide idea for Intellij IDEA or umake ide eclipse for Eclipse)
  • Chromium and Firefox Web browsers

This "development box" also have all client applications useful for working with a JHipster application:

  • MySQL Workbench
  • pgAdmin 3
  • MongoDB client
  • Cassandra command line (cqlsh)
  • Cloud Foundry command line (cf)
  • Heroku toolbelt

Installation

The "Quick installation" provides a pre-build Virtual Machine, and the "Manual installation" let you build your Virtual Machine yourself. We recommend you use the "Quick installation" if you don't know which option to choose.

Quick installation

Pre-built distributions of this "development box" are available on Vagrant Cloud.

To install the latest distribution, please run:

On Mac or Linux

vagrant init jhipster/jhipster-devbox; vagrant up --provider virtualbox

On Windows

vagrant init jhipster/jhipster-devbox

vagrant up --provider virtualbox

You can then tune your installation, by following the next sections on customizing and configuring your "development box".

Manual installation

This generates a new "development box" directly from this repository.

  • Clone this repository: git clone https://github.com/jhipster/jhipster-devbox.git
  • It is wise to use a tag to have a stable version: the JHipster DevBox tags are the same as the JHipster Generator tags, so using the DevBox v3.2.0 also means using the generator v3.2.0
  • Run vagrant up

Customize your virtual machine

This is very important! Modify your system properties, depending on your host's hardware. We recommend, at least:

  • 4 CPUs
  • 8 Gb of RAM
  • 128 Mb of video RAM

Configure your new box and install new software

Start up the new box:

  • Login using the vagrant user (not the 'Ubuntu' user which is selected by default)
    • Password is vagrant (please note that default keyboard layout is US!)
  • Configure your keyboard, if you are not using an English keyboard, once you have logged in:
    • Go to Settings > Keyboard
    • Open the Layout tab
    • Untick the Use system default box
    • Use the + sign to add your keyboard layout
  • Configure your IDE
    • Use Ubuntu Make so you can easily install your favorite IDE:
      • Type umake ide idea for Intellij IDEA
      • Type umake ide eclipse for Eclipse
  • Configure you browser
    • Firefox is installed
    • Chromium, which is the Open-Source version of Google Chrome, is also installed
  • Other available tools
    • Guake is installed, hit "F12" to have your terminal
    • The Atom text editor is installed
  • Generate your application
    • Run yo jhipster and use JHipster normally
  • Configure your database
    • Run your database with Docker. For example, for MySQL use docker-compose -f src/main/docker/mysql.yml up
    • In your application, don't forget to edit your application-dev.yml and application-prod.yml files so you have the correct connection setup for your database server
  • Use the JHipster tools
    • Running ./mvnw will run your JHipster application on port 8080. As this port is forwarded to your host, you can also use http://localhost:8080 on your host machine
    • Running gulp will launch your AngularJS front-end with BrowserSync on port 9000: it is also forwarded to your host, so you can also use http://localhost:9000 on your host machine