This application was generated using JHipster 3.12.2, you can find documentation and help at https://jhipster.github.io/documentation-archive/v3.12.2.
This is a "gateway" application intended to be part of a microservice architecture, please refer to the Doing microservices with JHipster page of the documentation for more information.
This application is configured for Service Discovery and Configuration with the JHipster-Registry. On launch, it will refuse to start if it is not able to connect to the JHipster-Registry at http://localhost:8761. For more information, read our documentation on Service Discovery and Configuration with the JHipster-Registry.
Before you can build this project, you must install and configure the following dependencies on your machine:
- Node.js: We use Node to run a development web server and build the project.
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
After installing Node, you should be able to run the following command to install development tools (like
Bower and BrowserSync). You will only need to run this command when dependencies change in package.json.
We use Gulp as our build system. Install the Gulp command-line tool globally with:
npm install -g gulp-cli
Run the following commands in two separate terminals to create a blissful development experience where your browser
auto-refreshes when files change on your hard drive.
specifying a newer version in
bower.json. You can also run
bower update and
bower install to manage dependencies.
-h flag on any command to see how you can use it. For example,
bower update -h.
For further instructions on how to develop with JHipster, have a look at Using JHipster in development.
Building for production
To optimize the microServiceGatewayStudent application for production, run:
./mvnw -Pprod clean package
index.html so it references these new files.
To ensure everything worked, run:
java -jar target/*.war
Then navigate to http://localhost:8080 in your browser.
Refer to Using JHipster in production for more details.
To launch your application's tests, run:
./mvnw clean test
Performance tests are run by Gatling and written in Scala. They're located in
src/test/gatling and can be run with:
For more information, refer to the Running tests page.
Using Docker to simplify development (optional)
You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the
src/main/docker folder to launch required third party services.
For example, to start a mysql database in a docker container, run:
docker-compose -f src/main/docker/mysql.yml up -d
To stop it and remove the container, run:
docker-compose -f src/main/docker/mysql.yml down
You can also fully dockerize your application and all the services that it depends on.
To achieve this, first build a docker image of your app by running:
./mvnw package -Pprod docker:build
docker-compose -f src/main/docker/app.yml up -d
For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (
yo jhipster:docker-compose), which is able to generate docker configurations for one or several JHipster applications.
Continuous Integration (optional)
To set up a CI environment, consult the Setting up Continuous Integration page.