Skip to content

Commit 24b2d76

Browse files
committed
[readme] modifying instructions
1 parent 730048f commit 24b2d76

File tree

1 file changed

+70
-11
lines changed

1 file changed

+70
-11
lines changed

README.md

Lines changed: 70 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@
55

66
Plug & Play Module
77

8-
parse & persist HTTP / REST API Calls
8+
9+
10+
### Description ###
11+
12+
13+
parse & persist HTTP / REST API Calls in MongoDB
914

1015

1116

@@ -38,26 +43,39 @@ Add (class level) annotation to java bean configuration class of the MongoDB Con
3843

3944

4045

41-
### Developer Setup ###
46+
### Collaborate - Developer Setup ###
4247

4348

44-
Clone via HTTPS
49+
Pre-requisite Tools (Softwares)
4550

46-
https://github.com/TurquoiseSpace/spring-webflux-http-interceptor.git
51+
JDK 1.8
52+
53+
Apache Maven
54+
55+
Git CLI
56+
57+
MongoDB Server
58+
59+
Robo3T
60+
61+
Java IDE - Eclipse / intelliJ
62+
63+
Postman / cURL
4764

4865

49-
Clone via SSH
66+
Clone via
5067

51-
git@github.com:TurquoiseSpace/spring-webflux-http-interceptor.git
68+
`HTTPS`
5269

70+
https://github.com/TurquoiseSpace/spring-webflux-http-interceptor.git
5371

54-
Clone via GitHub CLI
55-
56-
gh repo clone TurquoiseSpace/spring-webflux-http-interceptor
72+
`SSH`
5773

74+
git@github.com:TurquoiseSpace/spring-webflux-http-interceptor.git
5875

76+
`GitHub CLI`
5977

60-
### Collaborate ###
78+
gh repo clone TurquoiseSpace/spring-webflux-http-interceptor
6179

6280

6381
Set User Name & Email
@@ -78,6 +96,48 @@ Forget Git Remote Credentials
7896

7997

8098

99+
### Help - Starting off with "Spring WebFlux HTTP Interceptor" ###
100+
101+
102+
The actual code is located inside
103+
104+
./src/main/java/
105+
106+
with the base package as
107+
108+
open.source.exchange
109+
110+
and child packages (shows the call heirarchy from top to bottom)
111+
and in java files
112+
113+
interceptor
114+
ReactiveApiInterceptor.java
115+
service
116+
InformationExchangeService.java
117+
ParserHelper.java
118+
utility.asynchronous
119+
MonoCallSynchronousExecutor.java
120+
repository.asynchronous
121+
InformationExchangeRepoAsync.java
122+
parser
123+
ApplicationContextParser.java
124+
WebSessionParser.java
125+
LocaleContextParser.java
126+
ServerHttpRequestParser.java
127+
ServerHttpResponseParser.java
128+
PrincipalParser.java
129+
PartParser.java
130+
entity
131+
InformationExchange.java
132+
model
133+
Information.java
134+
enumeration
135+
ExchangeInformationType.java
136+
TimeEvent.java
137+
TimeUnit.java
138+
139+
140+
81141
### Coding Conventions ###
82142

83143

@@ -163,4 +223,3 @@ Publish
163223
mvn deploy --settings /home/mafia/.m2/setting.xml --global-settings /space/tools/apache-maven-3.6.3/conf/settings.xml
164224

165225

166-

0 commit comments

Comments
 (0)