This application was generated using JHipster 4.14.3, you can find documentation and help at http://www.jhipster.tech/documentation-archive/v4.14.3.
This is a "microservice" 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 Consul. On launch, it will refuse to start if it is not able to connect to Consul at http://localhost:8500. For more information, read our documentation on Service Discovery and Configuration with Consul.
To start your application in the dev profile, simply run:
./gradlew
For further instructions on how to develop with JHipster, have a look at Using JHipster in development.
Swagger-Codegen is configured for this application. You can generate API code from the src/main/resources/swagger/api.yml definition file by running:
./gradlew swaggerThen implements the generated interfaces with @RestController classes.
To edit the api.yml definition file, you can use a tool such as Swagger-Editor. Start a local instance of the swagger-editor using docker by running: docker-compose -f src/main/docker/swagger-editor.yml up -d. The editor will then be reachable at http://localhost:7742.
Refer to Doing API-First development for more details.
To optimize the jhipsterSampleApplication application for production, run:
./gradlew -Pprod clean bootRepackage
To ensure everything worked, run:
java -jar build/libs/*.war
Refer to Using JHipster in production for more details.
To launch your application's tests, run:
./gradlew test
Performance tests are run by Gatling and written in Scala. They're located in src/test/gatling and can be run with:
./gradlew gatlingRun
For more information, refer to the Running tests page.
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 mongodb database in a docker container, run:
docker-compose -f src/main/docker/mongodb.yml up -d
To stop it and remove the container, run:
docker-compose -f src/main/docker/mongodb.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:
./gradlew bootRepackage -Pprod buildDocker
Then run:
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 (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.
To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.