96 lines
4.2 KiB
Markdown
96 lines
4.2 KiB
Markdown
|
# uaa
|
||
|
|
This application was generated using JHipster 5.4.2, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v5.4.2](https://www.jhipster.tech/documentation-archive/v5.4.2).
|
||
|
|
|
||
|
|
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](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, simply run:
|
||
|
|
|
||
|
|
./mvnw
|
||
|
|
|
||
|
|
|
||
|
|
For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Building for production
|
||
|
|
|
||
|
|
To optimize the uaa 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.
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
To launch your application's tests, run:
|
||
|
|
|
||
|
|
./mvnw clean test
|
||
|
|
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
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](src/main/docker) folder to launch required third party services.
|
||
|
|
|
||
|
|
For example, to start a mysql database in a docker container, run:
|
||
|
|
|
||
|
|
docker-compose -f src/main/docker/mysql.yml up -d
|
||
|
|
|
||
|
|
To stop it and remove the container, run:
|
||
|
|
|
||
|
|
docker-compose -f src/main/docker/mysql.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 package -Pprod 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.
|
||
|
|
|
||
|
|
[JHipster Homepage and latest documentation]: https://www.jhipster.tech
|
||
|
|
[JHipster 5.4.2 archive]: https://www.jhipster.tech/documentation-archive/v5.4.2
|
||
|
|
[Doing microservices with JHipster]: https://www.jhipster.tech/documentation-archive/v5.4.2/microservices-architecture/
|
||
|
|
[Using UAA for Microservice Security]: https://www.jhipster.tech/documentation-archive/v5.4.2/using-uaa/[Using JHipster in development]: https://www.jhipster.tech/documentation-archive/v5.4.2/development/
|
||
|
|
[Service Discovery and Configuration with the JHipster-Registry]: https://www.jhipster.tech/documentation-archive/v5.4.2/microservices-architecture/#jhipster-registry
|
||
|
|
[Using Docker and Docker-Compose]: https://www.jhipster.tech/documentation-archive/v5.4.2/docker-compose
|
||
|
|
[Using JHipster in production]: https://www.jhipster.tech/documentation-archive/v5.4.2/production/
|
||
|
|
[Running tests page]: https://www.jhipster.tech/documentation-archive/v5.4.2/running-tests/
|
||
|
|
[Code quality page]: https://www.jhipster.tech/documentation-archive/v5.4.2/code-quality/
|
||
|
|
[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/v5.4.2/setting-up-ci/
|
||
|
|
|
||
|
|
|