Skip to content

Commit 357b572

Browse files
committed
update
1 parent 9e5138f commit 357b572

File tree

3 files changed

+32
-30
lines changed

3 files changed

+32
-30
lines changed

README.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,31 @@
1-
# Springboot-ReactJs Application built using an External Template
1+
# Spring Boot + ReactJS Application Built Using Build-Convention
22

3-
The web application manages a list of coffee shops.
3+
This web application manages a list of coffee shops.
44

5-
![img.png](screenshot.png)
5+
![Screenshot](screenshot.png)
66

7-
The project is fully built using JeKa with a [template](https://github.com/jeka-dev/demo-build-templates/blob/master/jeka-src/dev/jeka/demo/templates/springboot/reactjs/Template.java) containing the build logic.
7+
The project is fully built using **JeKa**, leveraging a [convention](https://github.com/jeka-dev/demo-build-conventions/blob/master/jeka-src/dev/jeka/demo/conventions/springboot/reactjs/Convention.java) that defines the build logic.
88

9-
This template is designed for building Spring Boot projects, with optional ReactJS apps. It handles tasks like testing with coverage, building the ReactJS app, running SonarQube analysis, and creating a Docker image.
9+
This build-convention is designed for building **Spring Boot** projects with an optional **ReactJS** frontend. It automates tasks such as:
1010

11-
End-to-end tests are located in the `e2e` package under the `src/test/java` directory. The `e2e` method manages the deployment and undeployment of the application using containers.
11+
- Running Java tests with code coverage,
12+
- Building and testing the ReactJS app,
13+
- Performing **SonarQube** analysis (Java and JS),
14+
- Creating Docker and native images.
1215

13-
<small>*jeka.properties*</small>
16+
End-to-end tests are located in the `e2e` package under the `src/test/java` directory.
17+
The end-2-end test handles deployment and un-deployment of the application using containers.
18+
19+
<small><i>Configured via <code>jeka.properties</code></i></small>
1420
```properties
15-
jeka.version=0.11.21
21+
jeka.version=0.11.39
1622
jeka.java.version=21
1723

1824
jeka.kbean.default=project
1925

20-
# Use build template defined at https://github.com/jeka-dev/demo-build-templates
21-
jeka.classpath=dev.jeka:template-examples:0.11.20-1
22-
@template=
26+
# Use the build convention defined at https://github.com/jeka-dev/demo-build-templates
27+
jeka.classpath=dev.jeka:convention-examples:0.11.39-2
28+
@convention=on
2329
```
2430

2531
## How to Use
@@ -34,22 +40,17 @@ jeka intellij: sync
3440

3541
Help on template KBean:
3642
```shell
37-
jeka template: --doc
38-
```
39-
40-
Create a bootable jar, containing the client app,:
41-
```shell
42-
jeka pack
43+
jeka convention: --doc
4344
```
4445

45-
Deploy the application in Docker then run end-to-end tests:
46+
Run a full build, including sonarqube and end-2-end tests
4647
```shell
47-
jeka e2eTest
48+
jeka build
4849
```
4950

50-
Run Sonarqube analysis, on both Java and JS:
51+
Run a full build, excluding sonar analysis
5152
```shell
52-
jeka checkQuality
53+
jeka test pack e2eTest
5354
```
5455

5556
Run the bootable jar:
@@ -67,4 +68,3 @@ Create a Spring-Boot native Docker image:
6768
jeka docker: buildNative
6869
```
6970

70-
For CI/CD, we can run `jeka pack e2eTest checkQuality` for instance.

dependencies.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
==== COMPILE ====
2-
org.springframework.boot:spring-boot-dependencies::pom:3.2.4
1+
[compile]
32
org.springframework.boot:spring-boot-starter-web
43
org.springframework.boot:spring-boot-starter-data-jpa
54
org.springframework.boot:spring-boot-starter-data-rest
65
org.springframework.boot:spring-boot-starter-actuator
76

8-
==== RUNTIME ====
9-
com.h2database:h2:2.1.214
7+
[runtime]
8+
com.h2database:h2
109

11-
==== TEST ====
10+
[test]
1211
org.springframework.boot:spring-boot-starter-test
1312
com.codeborne:selenide:7.2.3
13+
14+
[version]
15+
org.springframework.boot:spring-boot-dependencies:3.2.4@pom

jeka.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
jeka.version=.
21
jeka.java.version=21
32

43
jeka.kbean.default=project
54

65
# Use build template defined at https://github.com/jeka-dev/demo-build-templates
7-
jeka.classpath=dev.jeka:template-examples:0.11.23-1
8-
@template=
6+
jeka.classpath=dev.jeka:convention-examples:0.11.39-2
7+
@convention=on
8+
99

1010

1111

0 commit comments

Comments
 (0)