You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This application was generated using JHipster 9.0.0-beta.0, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v9.0.0-beta.0](https://www.jhipster.tech/documentation-archive/v9.0.0-beta.0).
3
+
This application was generated using JHipster 9.0.0-beta.3, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v9.0.0-beta.3](https://www.jhipster.tech/documentation-archive/v9.0.0-beta.3).
4
4
5
5
## Project Structure
6
6
@@ -27,18 +27,18 @@ The build system will install automatically the recommended version of Node and
27
27
We provide a wrapper to launch npm.
28
28
You will only need to run this command when dependencies change in [package.json](package.json).
29
29
30
-
```
30
+
```bash
31
31
./npmw install
32
32
```
33
33
34
-
We use npm scripts and [Angular CLI][] with [Webpack][] as our build system.
34
+
We use npm scripts and [Angular CLI](https://angular.dev/tools/cli) with Webpack as our build system.
35
35
36
36
Run the following commands in two separate terminals to create a blissful development experience where your browser
37
37
auto-refreshes when files change on your hard drive.
38
38
39
-
```
40
-
./npmw backend:start
41
-
./npmw start
39
+
```bash
40
+
./npmw run backend:start
41
+
./npmw run start
42
42
```
43
43
44
44
Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by
For example, to add [Leaflet][] library as a runtime dependency of your application, you would run the following command:
62
+
For example, to add [Leaflet](https://leafletjs.com/) library as a runtime dependency of your application, you would run the following command:
63
63
64
-
```
64
+
```bash
65
65
./npmw install --save --save-exact leaflet
66
66
```
67
67
68
-
To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run the following command:
68
+
To benefit from TypeScript type definitions from [DefinitelyTyped](https://definitelytyped.org/) repository in development, you would run the following command:
To build the final jar and optimize the jhipsterSampleApplication application for production, run:
114
114
115
-
```
115
+
```bash
116
116
./mvnw -Pprod clean verify
117
117
```
118
118
119
119
This will concatenate and minify the client CSS and JavaScript files. It will also modify `index.html` so it references these new files.
120
120
To ensure everything worked, run:
121
121
122
-
```
122
+
```bash
123
123
java -jar target/*.jar
124
124
```
125
125
@@ -131,15 +131,15 @@ Refer to [Using JHipster in production][] for more details.
131
131
132
132
To package your application as a war in order to deploy it to an application server, run:
133
133
134
-
```
134
+
```bash
135
135
./mvnw -Pprod,war clean verify
136
136
```
137
137
138
138
### JHipster Control Center
139
139
140
140
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:
141
141
142
-
```
142
+
```bash
143
143
docker compose -f src/main/docker/jhipster-control-center.yml up
144
144
```
145
145
@@ -149,25 +149,25 @@ docker compose -f src/main/docker/jhipster-control-center.yml up
149
149
150
150
To launch your application's tests, run:
151
151
152
-
```
152
+
```bash
153
153
./mvnw verify
154
154
```
155
155
156
156
### Gatling
157
157
158
-
Performance tests are run by [Gatling][] and written in Scala. They're located in [src/test/java/gatling/simulations](src/test/java/gatling/simulations).
158
+
Performance tests are run by [Gatling](https://gatling.io/) and written in Scala. They're located in [src/test/java/gatling/simulations](src/test/java/gatling/simulations).
159
159
160
160
You can execute all Gatling tests with
161
161
162
-
```
162
+
```bash
163
163
./mvnw gatling:test
164
164
```
165
165
166
166
### Client tests
167
167
168
-
Unit tests are run by [Jest][]. They're located near components and can be run with:
168
+
Unit tests are run by Vitest. They're located near components and can be run with:
169
169
170
-
```
170
+
```bash
171
171
./npmw test
172
172
```
173
173
@@ -178,7 +178,7 @@ and can be run by starting Spring Boot in one terminal (`./npmw run app:start`)
178
178
179
179
Before running Cypress tests, it's possible to specify user credentials by overriding the `CYPRESS_E2E_USERNAME` and `CYPRESS_E2E_PASSWORD` environment variables.
180
180
181
-
```
181
+
```bash
182
182
export CYPRESS_E2E_USERNAME="<your-username>"
183
183
export CYPRESS_E2E_PASSWORD="<your-password>"
184
184
```
@@ -188,16 +188,18 @@ See Cypress documentation for setting OS [environment variables](https://docs.cy
188
188
#### Lighthouse audits
189
189
190
190
You can execute automated [Lighthouse audits](https://developer.chrome.com/docs/lighthouse/overview) with [cypress-audit](https://github.com/mfrachet/cypress-audit) by running `./npmw run e2e:cypress:audits`.
191
+
191
192
You should only run the audits when your application is packaged with the production profile.
192
-
The lighthouse report is created in `target/cypress/lhreport.html`.
193
+
194
+
The Lighthouse report is created in `target/cypress/lhreport.html`.
193
195
194
196
## Others
195
197
196
198
### Code quality using Sonar
197
199
198
200
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
199
201
200
-
```
202
+
```bash
201
203
docker compose -f src/main/docker/sonar.yml up -d
202
204
```
203
205
@@ -207,19 +209,19 @@ You can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqu
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.
Additionally, Instead of passing `sonar.password` and `sonar.login` as CLI arguments, these parameters can be configured from [sonar-project.properties](sonar-project.properties) as shown below:
221
223
222
-
```
224
+
```bash
223
225
sonar.login=admin
224
226
sonar.password=admin
225
227
```
@@ -232,17 +234,17 @@ JHipster generates a number of Docker Compose configuration files in the [src/ma
232
234
233
235
For example, to start required services in Docker containers, run:
234
236
235
-
```
237
+
```bash
236
238
docker compose -f src/main/docker/services.yml up -d
237
239
```
238
240
239
241
To stop and remove the containers, run:
240
242
241
-
```
243
+
```bash
242
244
docker compose -f src/main/docker/services.yml down
243
245
```
244
246
245
-
[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enabled by default. It's possible to disable it in application.yml:
247
+
[Spring Docker Compose Integration](https://docs.spring.io/spring-boot/reference/features/dev-services.html) is enabled by default. It's possible to disable it in `application.yml`:
246
248
247
249
```yaml
248
250
spring:
@@ -255,43 +257,45 @@ spring:
255
257
You can also fully dockerize your application and all the services that it depends on.
256
258
To achieve this, first build a Docker image of your app by running:
257
259
258
-
```sh
260
+
```bash
259
261
npm run java:docker
260
262
```
261
263
262
-
Or build an arm64 Docker image when using an arm64 processor os like MacOS with M1 processor family running:
264
+
Or build an arm64 Docker image when using an arm64 processor OS, i.e., Apple Silicon chips (M\*), running:
263
265
264
-
```sh
266
+
```bash
265
267
npm run java:docker:arm64
266
268
```
267
269
268
270
Then run:
269
271
270
-
```sh
272
+
```bash
271
273
docker compose -f src/main/docker/app.yml up -d
272
274
```
273
275
274
-
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.
276
+
For more information refer to [Docker and Docker-Compose](https://www.jhipster.tech/documentation-archive/v9.0.0-beta.3/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.
275
277
276
278
## Continuous Integration (optional)
277
279
278
-
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.
279
-
280
-
[JHipster Homepage and latest documentation]: https://www.jhipster.tech/
[Setting up Continuous Integration]: https://www.jhipster.tech/documentation-archive/v9.0.0-beta.0/setting-up-ci/
288
-
[Node.js]: https://nodejs.org/
289
-
[NPM]: https://www.npmjs.com/
290
-
[Gatling]: https://gatling.io/
291
-
[Webpack]: https://webpack.js.org/
292
-
[BrowserSync]: https://www.browsersync.io/
293
-
[Jest]: https://jestjs.io
294
-
[Leaflet]: https://leafletjs.com/
295
-
[DefinitelyTyped]: https://definitelytyped.org/
296
-
[Angular CLI]: https://angular.dev/tools/cli
297
-
[Cypress]: https://www.cypress.io/
280
+
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](https://www.jhipster.tech/documentation-archive/v9.0.0-beta.3/setting-up-ci/) page for more information.
281
+
282
+
## References
283
+
284
+
-[JHipster Homepage and latest documentation](https://www.jhipster.tech/)
0 commit comments