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
Copy file name to clipboardExpand all lines: README.md
+61-9Lines changed: 61 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,15 +10,67 @@ Here is the [contract](https://github.com/specmatic/specmatic-order-contracts/bl
10
10
11
11
The architecture diagram was created using the amazing free online SVG editor at [Vectr](https://vectr.com).
12
12
13
-
### How to run the application?
13
+
### How to run the application manually?
14
14
15
-
1. Build the project using : `./mvnw clean install`
16
-
2. For unix platform, run the application using : `./mvnw spring-boot:run`
17
-
3. For windows platform, run the application using : `mvnw.cmd spring-boot:run`
15
+
#### 1. Build the project using maven:
16
+
17
+
- For unix platform and powerShell:<br/>
18
+
```shell
19
+
./mvnw clean install
20
+
```
21
+
22
+
- For windows command prompt:<br/>
23
+
```shell
24
+
mvnw.cmd clean install
25
+
```
26
+
27
+
#### 2. Run the application using maven:
28
+
29
+
- For unix platform and powerShell:<br/>
30
+
```shell
31
+
./mvnw spring-boot:run
32
+
```
33
+
34
+
- For windows command prompt:<br/>
35
+
```shell
36
+
mvnw.cmd spring-boot:run
37
+
```
18
38
19
39
### How to test the application?
20
-
1. Using maven: `mvn clean test`
21
-
2. Using docker:
22
-
- Start Docker Desktop
23
-
- Run the application `./mvnw spring-boot:run`
24
-
- Run the tests `docker run --network host -v "$PWD/specmatic.yaml:/usr/src/app/specmatic.yaml" -v "$PWD/build/reports/specmatic:/usr/src/app/build/reports/specmatic" specmatic/specmatic test --port=8090 --host=host.docker.internal`
40
+
41
+
#### 1. Using maven:
42
+
- For unix platform and powerShell:<br/>
43
+
```shell
44
+
./mvnw test
45
+
```
46
+
47
+
- For windows command prompt:<br/>
48
+
```shell
49
+
mvnw.cmd test
50
+
```
51
+
52
+
#### 2. Using Docker Desktop:
53
+
54
+
##### 1. Run the application using maven:
55
+
56
+
- For unix platform and powerShell:<br/>
57
+
```shell
58
+
./mvnw spring-boot:run
59
+
```
60
+
61
+
- For windows command prompt:<br/>
62
+
```shell
63
+
mvnw.cmd spring-boot:run
64
+
```
65
+
66
+
##### 2. Run the contract tests using Docker:
67
+
68
+
- For unix platform and powerShell:<br/>
69
+
```shell
70
+
docker run --rm -v --network host "$(pwd)/specmatic.yaml:/usr/src/app/specmatic.yaml" -v "$(pwd)/build/reports/specmatic:/usr/src/app/build/reports/specmatic" specmatic/specmatic test --port=8090
71
+
```
72
+
73
+
- For windows command prompt:<br/>
74
+
```shell
75
+
docker run --rm -v --network host "%cd%/specmatic.yaml:/usr/src/app/specmatic.yaml" -v "%cd%/build/reports/specmatic:/usr/src/app/build/reports/specmatic" specmatic/specmatic test --port=8090
0 commit comments