https://github.com/entando/token-plugin
A plugin that provides token support
https://github.com/entando/token-plugin
Last synced: 8 months ago
JSON representation
A plugin that provides token support
- Host: GitHub
- URL: https://github.com/entando/token-plugin
- Owner: entando
- License: mit
- Created: 2019-04-12T10:48:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-19T05:02:42.000Z (almost 5 years ago)
- Last Synced: 2025-02-01T03:27:40.059Z (over 1 year ago)
- Language: Java
- Size: 217 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tokenPlugin
This application was generated using JHipster 6.0.0-beta.0, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0](https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0).
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.
This application is configured for Service Discovery and Configuration with . On launch, it will refuse to start if it is not able to connect to .
## 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
### Packaging as jar
To build the final jar and optimize the tokenPlugin application for production, run:
./mvnw -Pprod clean package
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 package
## 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
```
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 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
```
or
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 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:
./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.
[jhipster homepage and latest documentation]: https://www.jhipster.tech
[jhipster 6.0.0-beta.0 archive]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0
[doing microservices with jhipster]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/microservices-architecture/
[using jhipster in development]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/development/
[using docker and docker-compose]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/docker-compose
[using jhipster in production]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/production/
[running tests page]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/running-tests/
[code quality page]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/code-quality/
[setting up continuous integration]: https://www.jhipster.tech/documentation-archive/v6.0.0-beta.0/setting-up-ci/