This application was generated using JHipster 5.6.1, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v5.6.1.
##Setting up the environment
To run the application locally you will need to install PostgreSQL, MongoDB and Java 11. Create a new database named ServiceNet in PostgreSQL and set up the following environment variables:
Optionally, you can install JHipster generator with the following command:
npm install -g generator-jhipster
IntelliJ Idea development
- Install Lombok, MapStruct nad NodeJS plugins under File -> Settings -> Plugins -> Browse repositories... search for the Lombok, MapStruct support and NodeJS plugins and install them all.
- Check the Enable annotation processing checkbox under File -> Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors.
- Import google styleguide settings under File -> Settings -> Editor -> Code Style, click on the little gear next to Scheme. Click on import Scheme and select the google-styleguide file (https://raw.githubusercontent.com/google/styleguide/gh-pages/intellij-java-google-style.xml) as the current code style for the project.
To start your application in the dev profile, simply run:
For further instructions on how to develop with JHipster, have a look at Using JHipster in development.
Building for production
To optimize the ServiceNet application for production, run:
./mvnw -Pprod clean package
To ensure everything worked, run:
java -jar target/*.war
Refer to Using JHipster in production for more details.
Building for staging
To run the ServiceNet application with staging profile (this profile is similar to production, but for testing purposes), run:
./mvnw -Pstaging clean package
To enable live reloading of your client-side code, run:
To launch your application's tests, run:
./mvnw clean test
For more information, refer to the Running tests page.
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
Then, run a Sonar analysis:
./mvnw -Pprod clean test 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 configuration are available in the src/main/docker folder to launch required third party services.
For example, to start a database in a docker container, run:
docker-compose -f src/main/docker/postgresql.yml up -d
To stop it and remove the container, run:
docker-compose -f src/main/docker/postgresql.yml down
You can also fully dockerize your application and all the services that it depends on. To achieve this, first build and run a docker image of your app by running one of these command options:
Production spring profile:
./mvnw package -Pprod jib:dockerBuild
docker-compose -f src/main/docker/app.yml up -d
Staging spring profile (this profile is similar to production, but for testing purposes):
./mvnw package -Pstaging jib:dockerBuild
docker-compose -f src/main/docker/app-staging.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.
Running re-create SQL script for Quartz data tables
Sometimes it may be a case where one would like to re-create Quartz DB structure. In order to do so run following in terminal in the project root directory (add credentials argument if required):
psql ServiceNet < src/main/resources/config/liquibase/tables_postgres.sql
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.