安装方式
我们提供了安装JHipster的5种方式:
JHipster Online是一种简单的方式来生成应用程序,而无需安装JHipster 。
使用Yarn本地安装是使用JHipster 的经典方式,所有的东西都安装在你的机器上,这可能有点复杂,但这就是大多数人通常工作的方式。
使用NPM本地安装是使用JHipster 的另一种经典方式。
Vagrant-based的“development box”,所有的工具都已经在基于ubuntu的虚拟机中建立起来了。
“Docker”容器,它为您安装了一个轻量级的、虚拟的容器,安装了JHipster。
JHipster Online(用户想要一个简单的方式来运行JHipster)
JHipster Online,用户可以轻松地生成JHipster应用程序,而不必安装JHipster。
这是为第一次尝试“JHipster”的人设计的,或者只是想看看“JHipster”提供的东西。
虽然它更容易使用,但它并不是“完全的JHipster体验”。如果你想生成应用程序,你仍然需要遵循下一节中的大部分步骤(使用Yarn本地安装),因为您仍然需要Java(运行您的应用程序)和Yarn(管理您的前端代码)。
在未来,我们希望JHipster Online能提供更多的功能。
使用Yarn本地安装(建议普通用户)
从Oracle网站上安装Java 8。
(可选)安装Java构建工具。
无论您选择使用Maven还是Gradle,您通常都不需要安装任何东西,因为JHipster 将自动安装Maven Wrapper或安装Gradle Wrapper。
如果您不想使用这些,请到官方的Maven网站或Gradle网站进行您自己的安装。
从git-scm.com安装Git。如果您使用Git,我们建议您也使用像SourceTree这样的工具。
从node.js网站安装node.js(更喜欢LTS版本)
从Yarn网站上安装Yarn
安装Yeoman:yarn global add yo
使用AngularJS 1,安装Bower:yarn global add bower
使用AngularJS 1,安装Gulp:yarn global add gulp-cli
安装JHipster:yarn global add generator-jhipster
注意:如果在全局使用这些工具有问题,确保你在你的路径里有$HOME/.config/yarn/global/node_modules/.bin。
在Mac或Linux:
export PATH="$PATH:`yarn global bin`:$HOME/.config/yarn/global/node_modules/.bin"
JHipster使用Yeoman来进行代码生成。在提交错误之前,请看看the Yeoman “getting starting” guide和Yarn documentation 可以找到更多的信息、技巧和帮助。
现在已经安装了JHipster,下一步就是创建应用。
使用NPM本地安装(代替Yarn)
从Oracle网站上安装Java 8。
(可选)安装Java构建工具。
无论您选择使用Maven还是Gradle,您通常都不需要安装任何东西,因为JHipster 将自动安装Maven Wrapper或安装Gradle Wrapper。
如果您不想使用这些,请到官方的Maven网站或Gradle网站进行您自己的安装。
从git-scm.com安装Git。如果您使用Git,我们建议您也使用像SourceTree这样的工具。
从node.js网站安装node.js(更喜欢LTS版本),这还将安装npm,这是我们在下一个命令中使用的节点包管理器。
(推荐)NPM更新:npm install -g npm
安装Yeoman:npm install -g yo
使用AngularJS 1,安装Bower:yarn global add bower
使用AngularJS 1,安装Gulp:yarn global add gulp-cli (如果您之前已经在全局安装了一个版本,请运行npm rm -g gulp,以确保与你的旧版本不会与gulp-cli冲突。)
安装JHipster:yarn global add generator-jhipster
(可选)安装Yarn:npm install -g yarn(如果是这样,在生成一个项目后,Yarn:安装代替npm安装)
Vagrant box 安装
JHipster development box 项目为您提供了一个虚拟机,它拥有所有必要的工具来开发您的JHipster 项目。
这是一种很简单的方法,可以快速地运行JHipster。
除了JHipster之外,这款虚拟机还包括许多开发工具,以及Docker,所以你应该准备好工作。
Docker安装(仅供高级用户)
请注意:这个Docker映像是用于在容器内运行jJHipster生成器。它完全不同于Docker and Docker Compose configurations
目的是在容器中运行您生成的JHipster应用程序。
信息
JHipster有一个特定的Dockerfile,提供了一个Docker镜像。
它可以利用Docker“自动构建”: https://hub.docker.com/r/jhipster/jhipster/
这个镜像可以让你在Docker内部运行JHipster。
先决条件
这取决于你的操作系统。
Linux:Linux支持Docker out-of-box。你只需在Docker网站上学习教程。
Mac和Windows:安装Docker工具箱,方便安装Docker。
由于生成的文件位于共享文件夹中,如果您停止了Docker容器,它们将不会被删除。但是,如果您不希望Docker每次启动容器时都要下载所有Maven和NPM依赖项,那么您应该提交它的状态或装入一个卷。
警告:基于您的操作系统,您的DOCKER_HOST将会有所不同。在Linux上,它将仅仅是您的本地主机。对于mac/windows,您必须使用以下命令获得IP:docker-machine ip default
提示: Kitematic是一个Docker工具箱提供的易于使用的图形界面,它将使安装更加容易。
在Linux上,如果用户不是docker组的,那么您需要以root用户身份运行docker命令。将用户添加到docker组是一个好主意,这样就可以将docker命令以非root用户运行。
使用linux/mac Windows(使用Docker工具箱)
Pull 这个镜像:
最新的JHipster Docker镜像:docker image pull jhipster/jhipster
开发版的JHipster Docker镜像:
docker image pull jhipster/jhipster:master
运行这个镜像:
警告:如果你在Mac或Windows上使用Docker机器,你的Docker守护进程只能访问你的OS X或Windows文件系统。Docker Machine试图自动分享您/Users (OS X)或C:\Users\<username> (Windows)目录。因此,您必须在这些目录下创建项目文件夹,以避免任何卷的装配问题。
在你的主目录中创建一个“jhipster”文件夹:
mkdir ~/jhipster
运行Docker映像,有以下选项:
Docker“/home/jhipster/app”文件夹被分享到本地的“~/jhipster”文件夹中。
转发所有由Docker公开的端口(Java应用程序的8080,浏览器同步的9000,浏览器同步UI的3001)。
docker container run --name jhipster -v ~/jhipster:/home/jhipster/app -v ~/.m2:/home/jhipster/.m2 -p 8080:8080 -p 9000:9000 -p 3001:3001 -d -t jhipster/jhipster
提示:如果您以前已经启动了容器,那么您不需要运行上面的命令,您可以简单地启动/停止现有的容器。
检查容器是否正在运行:
要检查您的容器是否正在运行,请使用以下命令docker container ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 4ae16c0539a3 jhipster/jhipster "tail -f /home/jhipst" 4 seconds ago Up 3 seconds 0.0.0.0:9000-3001->9000-3001/tcp, 0.0.0.0:8080->8080/tcp jhipster
一般操作
停止容器执行:docker container stop jhipster
再次开始,执行:docker container start jhipster
如果您更新了Docker映像(重新构建或从Docker hub获取),最好删除现有的容器,并重新运行容器。要做到这一点,首先要停止容器,移除它,然后再运行它:
docker container stop jhipster
docker container rm jhipster
docker image pull jhipster/jhipster
docker container run --name jhipster -v ~/jhipster:/home/jhipster/app -v ~/.m2:/home/jhipster/.m2 -p 8080:8080 -p 9000:9000 -p 3001:3001 -d -t jhipster/jhipster
访问容器
警告: 在 Windows 上,您需要作为管理员执行Docker Quick Terminal,使得能够在yarn install步骤中创建符号链接。
登录运行容器的最简单方法是执行以下命令:docker container exec -it <container_name> bash
如果您复制粘贴上述命令来运行容器,请注意您必须将JHipster指定为容器名称:docker container exec -it jhipster bash
您将以“jhipster”的用户身份登录。
docker container exec -it --user root jhipster bash
你的第一个项目
你可以在你的容器里找到/home/jhipster/app目录,然后开始在Docker内部构建你的应用:
cd /home/jhipster/app
jhipster
小贴士:如果你对Yarn有问题,你可以使用jhipster --npm,用npm代替Yarn。
一旦创建了应用程序,就可以运行所有常规的古尔/鲍/maven命令,例如:./mvnw
祝贺你!你已经在Docker中推出了你的JHipster app!
在你的主机上,你应该能够:
在http://DOCKER_HOST:8080上访问正在运行的应用程序
在共享文件夹中获取所有生成的文件
警告:默认情况下,Docker并不是安装在jhipster/jhipster的映像中。
所以你无法做到:
使用docker-compose文件
建立docker镜像 (Maven goal: dockerfile:build or Gradle task: buildDocker)