187 lines
7.5 KiB
Markdown
187 lines
7.5 KiB
Markdown
# gateway
|
|
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 "gateway" 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 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
|
|
|
|
Before you can build this project, you must install and configure the following dependencies on your machine:
|
|
|
|
1. [Node.js][]: We use Node to run a development web server and build the project.
|
|
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
|
|
|
|
After installing Node, you should be able to run the following command to install development tools.
|
|
You will only need to run this command when dependencies change in [package.json](package.json).
|
|
|
|
npm install
|
|
|
|
We use npm scripts and [Webpack][] as our build system.
|
|
|
|
Run the following commands in two separate terminals to create a blissful development experience where your browser
|
|
auto-refreshes when files change on your hard drive.
|
|
|
|
./mvnw
|
|
npm start
|
|
|
|
Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by
|
|
specifying a newer version in [package.json](package.json). You can also run `npm update` and `npm install` to manage dependencies.
|
|
Add the `help` flag on any command to see how you can use it. For example, `npm help update`.
|
|
|
|
The `npm run` command will list all of the scripts available to run for this project.
|
|
|
|
### Service workers
|
|
|
|
Service workers are commented by default, to enable them please uncomment the following code.
|
|
|
|
* The service worker registering script in index.html
|
|
|
|
```html
|
|
<script>
|
|
if ('serviceWorker' in navigator) {
|
|
navigator.serviceWorker
|
|
.register('./service-worker.js')
|
|
.then(function() { console.log('Service Worker Registered'); });
|
|
}
|
|
</script>
|
|
```
|
|
|
|
Note: workbox creates the respective service worker and dynamically generate the `service-worker.js`
|
|
|
|
### Managing dependencies
|
|
|
|
For example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:
|
|
|
|
npm install --save --save-exact leaflet
|
|
|
|
To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:
|
|
|
|
npm install --save-dev --save-exact @types/leaflet
|
|
|
|
Then you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:
|
|
Edit [src/main/webapp/app/vendor.ts](src/main/webapp/app/vendor.ts) file:
|
|
~~~
|
|
import 'leaflet/dist/leaflet.js';
|
|
~~~
|
|
|
|
Edit [src/main/webapp/content/css/vendor.css](src/main/webapp/content/css/vendor.css) file:
|
|
~~~
|
|
@import '~leaflet/dist/leaflet.css';
|
|
~~~
|
|
Note: there are still few other things remaining to do for Leaflet that we won't detail here.
|
|
|
|
For further instructions on how to develop with JHipster, have a look at [Using JHipster in development][].
|
|
|
|
### Using angular-cli
|
|
|
|
You can also use [Angular CLI][] to generate some custom client code.
|
|
|
|
For example, the following command:
|
|
|
|
ng generate component my-component
|
|
|
|
will generate few files:
|
|
|
|
create src/main/webapp/app/my-component/my-component.component.html
|
|
create src/main/webapp/app/my-component/my-component.component.ts
|
|
update src/main/webapp/app/app.module.ts
|
|
|
|
|
|
## Building for production
|
|
|
|
To optimize the gateway application for production, run:
|
|
|
|
./mvnw -Pprod clean package
|
|
|
|
This will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.
|
|
To ensure everything worked, run:
|
|
|
|
java -jar target/*.war
|
|
|
|
Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
|
|
|
|
Refer to [Using JHipster in production][] for more details.
|
|
|
|
## Testing
|
|
|
|
To launch your application's tests, run:
|
|
|
|
./mvnw clean test
|
|
|
|
### Client tests
|
|
|
|
Unit tests are run by [Jest][] and written with [Jasmine][]. They're located in [src/test/javascript/](src/test/javascript/) and can be run with:
|
|
|
|
npm 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 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/
|
|
|
|
|
|
[Node.js]: https://nodejs.org/
|
|
[Yarn]: https://yarnpkg.org/
|
|
[Webpack]: https://webpack.github.io/
|
|
[Angular CLI]: https://cli.angular.io/
|
|
[BrowserSync]: http://www.browsersync.io/
|
|
[Jest]: https://facebook.github.io/jest/
|
|
[Jasmine]: http://jasmine.github.io/2.0/introduction.html
|
|
[Protractor]: https://angular.github.io/protractor/
|
|
[Leaflet]: http://leafletjs.com/
|
|
[DefinitelyTyped]: http://definitelytyped.org/
|