Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shortthirdman/jhipsterquickstart

JHipster Quickstart
https://github.com/shortthirdman/jhipsterquickstart

angular angular-cli java jhipster jhipster-application quickstart spring-boot-2

Last synced: 21 days ago
JSON representation

JHipster Quickstart

Awesome Lists containing this project

README 

        
# jhipsterQuickstart

JHipster Quickstart



This application was generated using JHipster 7.9.3, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v7.9.3](https://www.jhipster.tech/documentation-archive/v7.9.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.

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][].



## Project Structure



Node is required for generation and recommended for development. `package.json` is always generated for a better development experience with prettier, commit hooks, scripts and so on.



In the project root, JHipster generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.



`/src/*` structure follows default Java structure.



- `.yo-rc.json` - Yeoman configuration file

  JHipster configuration is stored in this file at `generator-jhipster` key. You may find `generator-jhipster-*` for specific blueprints configuration.

- `.yo-resolve` (optional) - Yeoman conflict resolver

  Allows to use a specific action when conflicts are found skipping prompts for files that matches a pattern. Each line should match `[pattern] [action]` with pattern been a [Minimatch](https://github.com/isaacs/minimatch#minimatch) pattern and action been one of skip (default if ommited) or force. Lines starting with `#` are considered comments and are ignored.

- `.jhipster/*.json` - JHipster entity configuration files



- `npmw` - wrapper to use locally installed npm.

  JHipster installs Node and npm locally using the build tool by default. This wrapper makes sure npm is installed locally and uses it avoiding some differences different versions can cause. By using `./npmw` instead of the traditional `npm` you can configure a Node-less environment to develop or test your application.

- `/src/main/docker` - Docker configurations for the application and services that the application depends on



## 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 [Angular CLI][] with [Webpack][] as our build system.



If you are using hazelcast as a cache, you will have to launch a cache server.

To start your cache server, run:



```

docker-compose -f src/main/docker/hazelcast-management-center.yml up -d

```



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.



### PWA Support



JHipster ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.



The service worker initialization code is disabled by default. To enable it, uncomment the following code in `src/main/webapp/app/app.module.ts`:



```typescript

ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),

```



### 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/app.module.ts](src/main/webapp/app/app.module.ts) file:



```

import 'leaflet/dist/leaflet.js';

```



Edit [src/main/webapp/content/scss/vendor.scss](src/main/webapp/content/scss/vendor.scss) file:



```

@import '~leaflet/dist/leaflet.css';

```



Note: There are still a 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][].



### Developing Microfrontend



Microservices doesn't contain every required backend feature to allow microfrontends to run alone.

You must start a pre-built gateway version or from source.



Start gateway from source:



```

cd gateway

npm run docker:db:up # start database if necessary

npm run docker:others:up # start service discovery and authentication service if necessary

npm run app:start # alias for ./(mvnw|gradlew)

```



Microfrontend's `build-watch` script is configured to watch and compile microfrontend's sources and synchronizes with gateway's frontend.

Start it using:



```

cd microfrontend

npm run docker:db:up # start database if necessary

npm run build-watch

```



It's possible to run microfrontend's frontend standalone using:



```

cd microfrontend

npm run docker:db:up # start database if necessary

npm watch # alias for `npm start` and `npm run backend:start` in parallel

```



### 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

```



### JHipster Control Center



JHipster Control Center can help you manage and control your application(s). You can start a local control center server (accessible on http://localhost:7419) with:



```

docker-compose -f src/main/docker/jhipster-control-center.yml up

```



### Doing API-First development using openapi-generator-cli



[OpenAPI-Generator]() is configured for this application. You can generate API code from the `src/main/resources/swagger/api.yml` definition file by running:



```bash

./mvnw generate-sources

```



Then implements the generated delegate classes with `@Service` classes.



To edit the `api.yml` definition file, you can use a tool such as [Swagger-Editor](). Start a local instance of the swagger-editor using docker by running: `docker-compose -f src/main/docker/swagger-editor.yml up -d`. The editor will then be reachable at [http://localhost:7742](http://localhost:7742).



Refer to [Doing API-First development][] for more details.



## Building for production



### Packaging as jar



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



```

./mvnw -Pprod clean verify

```



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/*.jar

```



Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.



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 verify

```



## Testing



To launch your application's tests, run:



```

./mvnw verify

```



### Client tests



Unit tests are run by [Jest][]. 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

```



Note: we have turned off authentication in [src/main/docker/sonar.yml](src/main/docker/sonar.yml) for out of the box experience while trying out SonarQube, for real use cases turn it back on.



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

```



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:



```

npm run java:docker

```



Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:



```

npm run java:docker:arm64

```



Then run:



```

docker-compose -f src/main/docker/app.yml up -d

```



When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental `Use the new Virtualization framework` for better processing performance ([disk access performance is worse](https://github.com/docker/roadmap/issues/7)).



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 7.9.3 archive]: https://www.jhipster.tech/documentation-archive/v7.9.3

[doing microservices with jhipster]: https://www.jhipster.tech/documentation-archive/v7.9.3/microservices-architecture/

[using jhipster in development]: https://www.jhipster.tech/documentation-archive/v7.9.3/development/

[service discovery and configuration with the jhipster-registry]: https://www.jhipster.tech/documentation-archive/v7.9.3/microservices-architecture/#jhipster-registry

[using docker and docker-compose]: https://www.jhipster.tech/documentation-archive/v7.9.3/docker-compose

[using jhipster in production]: https://www.jhipster.tech/documentation-archive/v7.9.3/production/

[running tests page]: https://www.jhipster.tech/documentation-archive/v7.9.3/running-tests/

[code quality page]: https://www.jhipster.tech/documentation-archive/v7.9.3/code-quality/

[setting up continuous integration]: https://www.jhipster.tech/documentation-archive/v7.9.3/setting-up-ci/

[node.js]: https://nodejs.org/

[npm]: https://www.npmjs.com/

[webpack]: https://webpack.github.io/

[browsersync]: https://www.browsersync.io/

[jest]: https://facebook.github.io/jest/

[leaflet]: https://leafletjs.com/

[definitelytyped]: https://definitelytyped.org/

[angular cli]: https://cli.angular.io/

[openapi-generator]: https://openapi-generator.tech

[swagger-editor]: https://editor.swagger.io

[doing api-first development]: https://www.jhipster.tech/documentation-archive/v7.9.3/doing-api-first-development/