Skip to content

Commit 3772644

Browse files
committed
Add readme to sample-custom-ui
1 parent d8e0a89 commit 3772644

File tree

2 files changed

+37
-5
lines changed
  • spring-boot-admin-samples/spring-boot-admin-sample-custom-ui
  • spring-boot-admin-server-ui

2 files changed

+37
-5
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
spring-boot-admin-sample-custom-ui
2+
================================
3+
4+
### Building this module
5+
The jar **can be build with Maven** with the maven-exec-plugin. To do this node.js and npm must be installed on your machine and be on your `$PATH`.
6+
If you don't want to use the maven exec run the following commands:
7+
8+
### Running Spring Boot Admin Server for development
9+
To develop the ui on an running server the best to do is
10+
11+
1. Running the ui build in watch mode so the resources get updated:
12+
```shell
13+
npm run watch
14+
```
15+
2. Run a Spring Boot Admin Server instances with the template-location and resource-location pointing to the build output and disable caching:
16+
```
17+
spring.boot.admin.ui.cache.no-cache: true
18+
spring.boot.admin.ui.extension-resource-locations: file:@project.basedir@/../spring-boot-admin-sample-custom-ui/target/dist/
19+
spring.boot.admin.ui.cache-templates: false
20+
```
21+
Or just start the [spring-boot-admin-sample-servlet](../spring-boot-admin-sample-servlet) project using the `dev` profile.
22+
23+
### Build
24+
```shell
25+
npm install
26+
npm run build
27+
```
28+
29+
Repeated build with watching the files:
30+
```shell
31+
npm run watch
32+
```

spring-boot-admin-server-ui/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ npm run watch
1414
```
1515
2. Run a Spring Boot Admin Server instances with the template-location and resource-location pointing to the build output and disable caching:
1616
```
17-
spring.boot.admin.cache.no-cache: true
18-
spring.boot.admin.resource-locations: file://@project.basedir@/../../spring-boot-admin-server-ui/target/dist/
19-
spring.boot.admin.template-location: file://@project.basedir@/../../spring-boot-admin-server-ui/target/dist/
20-
spring.boot.admin.cache-templates: false
17+
spring.boot.admin.ui.cache.no-cache: true
18+
spring.boot.admin.ui.resource-locations: file://@project.basedir@/../../spring-boot-admin-server-ui/target/dist/
19+
spring.boot.admin.ui.template-location: file://@project.basedir@/../../spring-boot-admin-server-ui/target/dist/
20+
spring.boot.admin.ui.cache-templates: false
2121
```
2222
Or just start the [spring-boot-admin-sample-servlet](../spring-boot-admin-samples/spring-boot-admin-sample-servlet) project using the `dev` profile.
2323

@@ -40,4 +40,4 @@ npm run test
4040
Repeated tests with watching the files:
4141
```shell
4242
npm run watch:test
43-
```
43+
```

0 commit comments

Comments
 (0)