Skip to content

The repository for the back end component of the Hotel

License

Notifications You must be signed in to change notification settings

My-DIGI-ID/hotel-controller

Repository files navigation

Hotel-Controller

This application was generated using JHipster 6.10.5, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v6.10.5.

Prerequisites

Add hotel-agent-url, hotel-agent-key,credential-definition-id in application-dev.yml file. For more information refer network/README.MD

Development

To start your application in the dev profile, open the terminal, navigate to the hotel-controller folder and run the following commands:

docker-compose -f src/main/docker/mongodb.yml up -d

source ./scripts/set_local_environment_variables.sh

./mvnw -Dspring.profiles.active=dev

The first step will deploy a MongoDB instance. The second command will set some environment variables for local development. The last step will deploy the application.

Swagger-Ui

Swagger UI will be available at the following URL

http://localhost:8090/swagger-ui/index.html?configUrl=/v1/api-docs/swagger-config#/

Note: The API key can be configured in src/main/resources/config/application-dev.yml (application properties) file which can be used to interact with the API.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

AdminMongo

AdminMongo is running in Port 8092

  • localhost:8092
  • Connection-Name: Hotel Controller
  • Connection-String: mongodb://{mongodb-username}:{mongodb-password}@docker_hotelcontroller-mongodb_1:27017/HotelController?authSource=HotelController

Building Docker Image

To build a docker dev image, run:

./mvnw package jib:dockerBuild

This one creates a new docker image with the name hotelcontroller. To run the controller + MongoDB and the mongoadmin, run:

docker-compose -f src/main/docker/controller-mongo-mongoadmin.yml up -d

Building for production

Packaging as jar

To build the final jar and optimize the hotel-controller application for production, run:

./mvnw -Pprod clean verify

To ensure everything worked, run:

java -jar target/*.jar

Refer to Using JHipster in production for more details.

Packaging as war

To package your application as a war in order to deploy it to an application server, run:

./mvnw -Pprod,war clean verify

Testing

To launch your application's tests, run:

./mvnw verify

For more information, refer to the Running tests page.

Code quality

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker-compose -f src/main/docker/sonar.yml up -d

You can run a Sonar analysis by using the sonar-scanner or by using the Maven plugin.

Then, run a Sonar analysis:

./mvnw -Pprod clean verify sonar:sonar

If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.

./mvnw initialize sonar:sonar

For more information, refer to the Code quality page.

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configurations 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:

./mvnw -Pprod verify jib:dockerBuild

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.

Continuous Integration (optional)

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.

About

The repository for the back end component of the Hotel

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages