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
+15-5Lines changed: 15 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -47,14 +47,24 @@ Sponge is mainly based on `SQL` and `Protobuf` two ways to generate code, each w
47
47
48
48
### Microservice framework
49
49
50
-
Sponge is essentially a microservice framework that includes code generation capabilities. The microservice framework is shown in the following figure, which is a typical microservice hierarchical structure, with high performance, high scalability, contains commonly used service governance features, you can easily replace or add their own service governance features.
50
+
Sponge is also a microservices framework, the framework diagram is shown below, which is a typical microservice hierarchical structure, with high performance, high scalability, contains commonly used service governance features, you can easily replace or add their own service governance features.
Click to view the [**test code**](https://github.com/zhufuyi/microservices_framework_benchmark).
65
+
66
+
<br>
67
+
58
68
### Key Features
59
69
60
70
- Web framework [gin](https://github.com/gin-gonic/gin)
@@ -83,7 +93,7 @@ Sponge is essentially a microservice framework that includes code generation cap
83
93
84
94
### Project Code Directory Structure
85
95
86
-
The project code directory structure created by sponge follows the [project-layout](https://github.com/golang-standards/project-layout)convention and is structured as follows:
96
+
The project code directory structure created by sponge follows the [project-layout](https://github.com/golang-standards/project-layout) and is structured as follows. Supported repository types are `monolithic application single repository (monolith)`, `microservice multi-repository (multi-repo)`, `microservice single repository (mono-repo)`.
87
97
88
98
```bash
89
99
.
@@ -120,7 +130,7 @@ The project code directory structure created by sponge follows the [project-layo
120
130
121
131
#### Installation sponge
122
132
123
-
sponge can be installed on Windows, macOS, Linux and Docker environments. Click here for [instructions on installing sponge](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md).
133
+
Sponge can be installed on Windows, macOS, Linux and Docker environments. Click here for [instructions on installing sponge](https://github.com/zhufuyi/sponge/blob/main/assets/install-en.md).
124
134
125
135
#### Starting UI service
126
136
@@ -144,7 +154,7 @@ Detailed instructions for operating, configuring, and deploying a project using
144
154
145
155
### Examples of use
146
156
147
-
#### Examples of creating a service using sponge
157
+
#### Examples of create services
148
158
149
159
-[Create **web** service based on **sql** (including CRUD)](https://github.com/zhufuyi/sponge_examples/tree/main/1_web-gin-CRUD)
150
160
-[Create **grpc** service based on **sql** (including CRUD)](https://github.com/zhufuyi/sponge_examples/tree/main/2_micro-grpc-CRUD)
@@ -153,7 +163,7 @@ Detailed instructions for operating, configuring, and deploying a project using
153
163
-[Create **grpc gateway** service based on **protobuf**](https://github.com/zhufuyi/sponge_examples/tree/main/5_micro-gin-rpc-gateway)
154
164
-[Create **grpc+http** service based on **protobuf**](https://github.com/zhufuyi/sponge_examples/tree/main/a_micro-grpc-http-protobuf)
155
165
156
-
#### Examples of developing a complete project using sponge
166
+
#### Examples of develop complete project
157
167
158
168
-[Simple community web backend service](https://github.com/zhufuyi/sponge_examples/tree/main/7_community-single)
159
169
-[Simple community web service broken down into microservice](https://github.com/zhufuyi/sponge_examples/tree/main/8_community-cluster)
0 commit comments