/finscale-identity-alpha

UAA Service for finscale.

Primary LanguageKotlin

identity

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

This is a "uaa" 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 is also a JHipster User Account and Authentication (UAA) Server, refer to [Using UAA for Microservice Security][] for details on how to secure JHipster microservices with OAuth2. 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][].

Development

To start your application in the dev profile, run:

./gradlew

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

Building for production

Packaging as jar

To build the final jar and optimize the identity application for production, run:



./gradlew -Pprod clean bootJar

To ensure everything worked, run:



java -jar build/libs/*.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:



./gradlew -Pprod -Pwar clean bootWar

Testing

To launch your application's tests, run:

./gradlew test integrationTest jacocoTestReport

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 with using the sonar-scanner or by using the gradle plugin.

Then, run a Sonar analysis:

./gradlew -Pprod clean check jacocoTestReport sonarqube

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 postgresql 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 a docker image of your app by running:

./gradlew bootJar -Pprod jibDockerBuild

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.

[Using UAA for Microservice Security]: https://www.jhipster.tech/documentation-archive/v6.10.1/using-uaa/[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/v6.10.1/development/ [Service Discovery and Configuration with the JHipster-Registry]: https://www.jhipster.tech/documentation-archive/v6.10.1/microservices-architecture/#jhipster-registry [Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/v6.10.1/docker-compose [Using JHipster in production]: https://www.jhipster.tech/documentation-archive/v6.10.1/production/ [Running tests page]: https://www.jhipster.tech/documentation-archive/v6.10.1/running-tests/ [Code quality page]: https://www.jhipster.tech/documentation-archive/v6.10.1/code-quality/ [Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/v6.10.1/setting-up-ci/