You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

126 lines
4.4 KiB

3 years ago
  1. # organismeFormation
  2. 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](https://www.jhipster.tech/documentation-archive/v6.10.5).
  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.
  4. 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](http://localhost:8761). For more information, read our documentation on [Service Discovery and Configuration with the JHipster-Registry][].
  5. ## Development
  6. To start your application in the dev profile, run:
  7. ```
  8. ./gradlew
  9. ```
  10. For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].
  11. ## Building for production
  12. ### Packaging as jar
  13. To build the final jar and optimize the organismeFormation application for production, run:
  14. ```
  15. ./gradlew -Pprod clean bootJar
  16. ```
  17. To ensure everything worked, run:
  18. ```
  19. java -jar build/libs/*.jar
  20. ```
  21. Refer to [Using JHipster in production][] for more details.
  22. ### Packaging as war
  23. To package your application as a war in order to deploy it to an application server, run:
  24. ```
  25. ./gradlew -Pprod -Pwar clean bootWar
  26. ```
  27. ## Testing
  28. To launch your application's tests, run:
  29. ```
  30. ./gradlew test integrationTest jacocoTestReport
  31. ```
  32. For more information, refer to the [Running tests page][].
  33. ### Code quality
  34. Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
  35. ```
  36. docker-compose -f src/main/docker/sonar.yml up -d
  37. ```
  38. You can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) or by using the gradle plugin.
  39. Then, run a Sonar analysis:
  40. ```
  41. ./gradlew -Pprod clean check jacocoTestReport sonarqube
  42. ```
  43. For more information, refer to the [Code quality page][].
  44. ## Using Docker to simplify development (optional)
  45. You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the [src/main/docker](src/main/docker) folder to launch required third party services.
  46. For example, to start a mssql database in a docker container, run:
  47. ```
  48. docker-compose -f src/main/docker/mssql.yml up -d
  49. ```
  50. To stop it and remove the container, run:
  51. ```
  52. docker-compose -f src/main/docker/mssql.yml down
  53. ```
  54. You can also fully dockerize your application and all the services that it depends on.
  55. To achieve this, first build a docker image of your app by running:
  56. ```
  57. ./gradlew bootJar -Pprod jibDockerBuild
  58. ```
  59. Then run:
  60. ```
  61. docker-compose -f src/main/docker/app.yml up -d
  62. ```
  63. 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.
  64. ## Continuous Integration (optional)
  65. 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.
  66. [jhipster homepage and latest documentation]: https://www.jhipster.tech
  67. [jhipster 6.10.5 archive]: https://www.jhipster.tech/documentation-archive/v6.10.5
  68. [doing microservices with jhipster]: https://www.jhipster.tech/documentation-archive/v6.10.5/microservices-architecture/
  69. [using jhipster in development]: https://www.jhipster.tech/documentation-archive/v6.10.5/development/
  70. [service discovery and configuration with the jhipster-registry]: https://www.jhipster.tech/documentation-archive/v6.10.5/microservices-architecture/#jhipster-registry
  71. [using docker and docker-compose]: https://www.jhipster.tech/documentation-archive/v6.10.5/docker-compose
  72. [using jhipster in production]: https://www.jhipster.tech/documentation-archive/v6.10.5/production/
  73. [running tests page]: https://www.jhipster.tech/documentation-archive/v6.10.5/running-tests/
  74. [code quality page]: https://www.jhipster.tech/documentation-archive/v6.10.5/code-quality/
  75. [setting up continuous integration]: https://www.jhipster.tech/documentation-archive/v6.10.5/setting-up-ci/