From 7d7d60e5e3b12e10f5d3befdb46b5fea020c17d0 Mon Sep 17 00:00:00 2001
From: zhuyasen
### Applicable Scenarios
-Sponge is suitable for rapidly building various types of high-performance backend services, including but not limited to:
+**Sponge** is ideal for rapidly building various types of high-performance backend services. Applicable scenarios include:
-- `RESTful API` services
-- `Web` services (Gin-based)
-- `gRPC` services
-- `HTTP+gRPC` hybrid services
-- `gRPC Gateway API` services
-- `cloud-native` microservices
+* Developing internal enterprise API services
+* Quickly building microservices
+* Creating APIs for backend management systems
+* Building gRPC services for inter-service communication
+* Serving as a starting point for Go beginners or teams to learn Go project structure and best practices
+* Supporting teams that need to improve development efficiency and standardize coding practices
+* Cloud-native development
-Additionally, developers can use custom templates to generate various types of code to meet specific business needs.
+In addition, developers can generate business-specific code by customizing templates.
-### Core Advantages
+### Key Features
1. **One-click generation of complete backend service code**
For `Web` or `gRPC` services that only require `CRUD APIs`, no `Go` code needs to be written. Simply connect to a database (e.g., `MySQL`, `MongoDB`, `PostgreSQL`, `SQLite`) to one-click generate complete backend service code and easily deploy it to Linux servers, Docker, or Kubernetes.
@@ -71,7 +70,7 @@ Additionally, developers can use custom templates to generate various types of c
1. **Install sponge**
- Sponge supports installation on Windows, macOS, and Linux. Click to view the [**sponge installation guide**](https://github.com/go-dev-frame/sponge/blob/main/assets/install-en.md).
+ Sponge supports installation on Windows, macOS, Linux and Docker. Click to view the [**sponge installation guide**](https://github.com/go-dev-frame/sponge/blob/main/assets/install-en.md).
2. **Open the code generation UI**
@@ -87,7 +86,7 @@ Additionally, developers can use custom templates to generate various types of c
@@ -139,7 +138,7 @@ The code generation engine of sponge supports two methods for generating the req
-2. The framework for code generation based on custom templates in sponge is shown below, supporting JSON, SQL, and Protobuf formats.
+2. Sponge generates a code framework based on custom templates, as shown in the diagram below:
@@ -147,7 +146,7 @@ The code generation engine of sponge supports two methods for generating the req
-3. Sponge generates business logic code framework based on function description information, as shown in the following figure:
+3. Sponge generates a business logic code framework based on functions and comments, as shown in the diagram below:
@@ -157,10 +156,10 @@ The code generation engine of sponge supports two methods for generating the req
### Microservice framework
-Back-end services created by sponge are typical microservice architectures. The diagram below illustrates a typical layered microservice structure, featuring high performance, scalability, and built-in service governance capabilities.
+**Sponge** is a modern Go microservice framework that adopts a typical layered microservice architecture. It comes with a rich set of built-in service governance features, enabling developers to quickly build and maintain complex microservice systems. The structure of the framework is shown in the diagram below:
-
+
94Z=``>9pG#su3`>$zKDT&Rx^6t8pDnbjx_nsOQszv9^oV}x zcqO%X&?Mv;(3-sriYb9NM+-ST|Ww z$$}7zzHhs+{&ba5H5OXKD3x8=$yMy72@+k^-gwJW5AS^_0*Zvy z{vg;hq$BQHaVv|mwK{KQ^UEHKWX>IUBuN+qm#IaGu1dcd6Roiz04Zexae4O{dt%rW zS!Xq1;gF7)S;#H(e^LPJxRg_Nz{e$^vkB8{J^h 400&XLMeY+0h$cq@-bz(>|T4h)c}9O1)r%Z8~79#zlS23{{u=r^tJyhEStE#3aS z!w%Ynz=0Pk5P+WDHcfAEpL8f3K{PvQ-Vz@rUF$;a@Few%l74!n^dg1wp?q?;5lJBV z=055xpP&vyIbl&p8bK4}8jD)_zuv&@oXhaEzO;mw(^sW!%ehyc1!&(+c!&kS-#c1e zJH}Qt=F1fTZ>a|LXXhK+vLg15xz!dPC-o#}HKzxnk9yLNOfA{>7NmsVsk?lX^c?aOcf6+M|a$kTK%dIJ=hc>Q9dK8dq7k*OjGvP>c(UOLnN5 zr*9e7`G_wSa64RGV&mwlEZ (7G%zE zMA`_C6oiop^b;9u^T(Q b_&u@Q#DH!WcT#rux(=#iLb5*@$V!UgolgRdK| c&ex`lkX_GQnvnLexICTw=mRx6&wkuY 5+Q zox^BF?0G@T%YpL*9|{s@RF9a~7XpcYwxlHNP`VsBUuk^VP8jdEv+%yl6(Q=e>%4XU zF{}>cnMX_eT`w#N*TVDW`iO9a7=&Xv+5K8~k0MuXkL1PUU-_(7lBeGhSzc3R)xQjy zg^47E55LLV0kNXqP#h|9Vfr3-C*(&KoLkp?t>x2JecJS^o`%ZTQRK%RPFlYwN?kI9 zPf<-nR}9mw*^pg+YqmZ_YW}YqcV)PSnviO&TnI -#_#4Q#mw?w=1IMun&69)0gbMJt$m sK!H0bJ!(FTf`Mj)>mzg!&5^L zh}`r0D%|}fy-KrCS#AQamd%x8gaPC=#Q3v$ZMe>!cMCU&ZbR9r%BM>Ur#BKht2q~I z@?t39x(QY Lo}pP}9+Y4-Umhs@{4E%b?n?;aSE&Uc&h~f&h^afJ zjrd8WA*nu~bQ<0o0vgP^@9QJFL|H` aJaWKKe38u1 92Qjv5yxxQxy> S|%i+@zhY5nQMDPU#1^WEsw#9Jf_fdPno`J)0oH7@RoBWbpXEm&CYJX1R zd?xzab|E%9IdN3kCh{4uV#3 %JRA Oqv7XMQdK@AJ&;Bw2iSXXFl7#g% <}qpm2iv*=0cia`({P)%yHTP^(Y#)2k8i1RDRl@1`c7@nej@ zr5V>zx*xFBh(JibGCz5zPz7xVVD)cy4H*~0f&q-@yx2P7s_$Sc*34;2!Qjull0- z&&Qb`1{Zcg2lsNSjC;9Y{$Qq4Sj@$$ldz*p+Ly!WIV-$C_TMh^!bK>>{Jg?d$6-e= zwRslP^Zq;;Tu$4L*%8^S6NNSlM*31$F|=TM8N{uFOTPsEN0^^Z!Q;)DU`+9vzUFPq z;CdSP+InnMEYyf`De?tZx#?Qd&Cm_wC;n5*h_P36Tx&i6AtUR~;JdIsz3SO+Vo@9H zHOBkPfcLC%8)Mo8sygbUd?-X7zqq-LpEvibpgUVnZT^W1Ci|&~iM=4Y=1?g(MKBb~ z+5B(r6I*doF)j2Sa0B{U+WUN>@@@}# e!1;`}&ZU_|2W2|SJB}K9E!yWinWZ(KX)@z_^sZB!rbO^; zogbyY8DoJ|1hk)mJk{%`DQ4!ognQnb%KTB%n_7D6vkkTb-><)I;~UbBu1=UOOb}QU z({QGBiM8c}Yivs~C^s-L(a)!?czSNF)J15am4kP2Th9vlqw9hh?-(SR(Q%8PbT6&L z74}x^iAQR5XqO`QHKUpz@NXdawCS$)o+O+GjVwq<47~uxUBU-BcmMOFl^()8y|wvf z71I?^_E{Ml2WbLhtZ4psT c7iyBYFxt=-VQH_Rz^uqMv| z_;=Xw`iJ9;2fg1O9AmuR om!w>q- zsS4dq!Q7`lRF-= N-R^!tr0Tr^_Dh%M;7jav)Rpna> z6WTr7JS-pi!IamGw+<8!_P!$ifEvjlZb4P~4@@xQtPpWZJHy|2xW{;(0k+qx^KFj| zJ0cV!^pN|=w !dqe*wThMXX_FJwL^QJh*2iS}<~BjCi1Ju%v*%gH8E;~M zR`eV6Nl1CXsQ)p#*_j`U;M+9iC$GvF(M>kH_6n-Ts&icA>HOVZb}QfoI778wzO;V3 zii0h%BrmeFS`nxBXo&LYK1KT{GWy;Mr!$`JxL-5aLG$3pM)FyC{p Zl#_IhnH z(TUQhQ1az5W08Dm7I%!k&92u}pDmQ2@6$&lE_(xsWWO)~ukbNOHSal}IBU%>#ens; zGbG;VJKpL*SD;ZZyxFqFX^jz_R>vb(16qoCVogA4!Wh-ltAn~UXSFW|YHIxC(VjTx zZxh*JZ?vpLr@isW=*W0eNY9~B5@Vwr;dR~_kF|f-c<>0Oa&OW8OQ>Y|%)o^^-^2!6 zog*W7Ygx)MH?4%eE&FP*c@3vWqJXTOF=BQ9Pmac5#DDqTAzc|o;<2?ep9rN j2^9(G@jmD*%M=ihMifsFG zuU~P;NAdUGvfeVLu5HsOEBz?bbo=_}KmPRdl;+j_W6#?o@ig%t|M@&&NFt$qYh|cl zz*M9KO&rIe2njFl6DefhI#_8Ilx#!eH8B>HNsQ5(;`)ce58r}HD`*&?TA>I6jYs+n zrv&~|Srvj>VbI7{ocqIAO9xCmphrtKx #KY|(H9IEI0}YCSid&UtGaA5B0-~q9k55Q4H=kRdOZk{X&S~@GA2@U zy%35|C0uRMfV`3ylGu@a`?Y-Py_jU_3)GPqY7pX{D>^# VyG?+7Q1va*fNZbc5A9==%3wddxfd> zljfJ6xN_4K;%AZ?#7uu=_n16!qc%~1R84VyIXVMoV6QSDiP#J3G?^&*(us@Mu2@Oz z(pJoxPV@zBSN)=`W-N^}qRwV7_-^F`8|4jr=L;LUqBcEJb3BHxtx!L)p`eBo&GukO z`~};ouuYoYqHNRSYLXvbSG!D5{w+lj#E92xA^bwh<<+@z;Pqixk7YxOO)k0$ m0f-VDZ zq*MK@c?h+ )*)%v|_Z}R>r`S+Cu#|#VyAOeot1 7!pR@ zL~f%eB4=n|yhf>FyUb?i`&7(gQ$qnN$%<0pwvw<%_`MH)Bfq+$!iu65!3W33Y@`5w zf4#}j?NuB6KvNxVI5FnLnb=@XXFZ=L6DjK5G2^h<4&BuBp-tahxAQ{rSs!-CKG;1i zs1Y>5+}nbuXBuCKw~*f$s3Fb=$1kK0xr}HPDxCwns`1BwH}x-jdmu4NZS=PE z1j|>eA4L|&B%TzN+hr)MRY)z4B>Cc(Y$mkZ2kIm%X5QM+iTrrMnt1*i-Idcd#P>GM zePXqKi$)!1TKp1Yl9iQw$N6=}U*!6sx)uAaS@iYcn4~SeyKvWLyO`u4+yrGqz`|3% zyGmfFe04X-7*kkL;5IRDgEx+*YR4s|Zlm2Fy&Y{v5h@Vb@83H_WpnZ2Lp6?t^y z#$8 PA8E z;M`EI`kzvIG#zW~W3A-1%PvU6W%b4zZnbOP^XZd`X}cG*+ `tnQ?>IP>snou5L2%fB_a#Qc( zF2r01*BvSj3_o0w=Y-v{yJ5+)X1&AjfJk|z_?)5?x57@)(_LY!o!w`nRghM#C+HCl zP4bJ+xCg?_bES((J2nz4l-60%-`Gi|a9P?cwKgY4zG;LB#hTN6@ij$SdSho?scCsl zF&I@3jK#qCz&CkPY_V}Cv?us=+EX0#t0%{YW`F9DcjlmYk=iVF@fWNkPDa)y5ktd_ zb4mO 6&;;pOL+6kb3 zB}JX@Ay;T{m;!Mx7Q~7*;P%BsurrGlQYPho-`Q?-l}U*=qP|Q$9Pf%7L4W#b%%N#0 zXD{V}zMK_sc}-sM$^rg_h2@E%{o1+HSH~Ubrd#+i(#$($452wuIIGzwLc4}>)>TGq z(j1byiuFT9_rbY@Dw;>j$rl}zl{N=s9*qpn5t);e^*+ge>PA*adt%A&^oQgc3;f>W zCKR6#gaMi|?L|-+;F^eN(;&`{53i(*F2{H{2%uAf^$esP7TcPXYB3b7tQc72a`Pe- z71>83+M;zin+EB-7j-(77a!aI*4Ie$!b6pbwgD8gzWx))Q xl1^lmW0CPZc3x_T6Q(5qa3Xo%D%JN>Z@$>Oap*j9YY{zB|32!L}js z1^e=It+i^=*7vE_aC4$GIK#4%frb4zh_+#d&idC8Mc1&k0&A6f(S?yD9!2qLKbvmf zlB>RH>b``LW?4_>7kP^D{1tC1D542pjxf*Ekb+&IcP@V{76B!hio6M_(PrlrRvBHL z=EfV-gIm=0No? hJ6FP)e zP~-J*3z&`KucLmAgLqwy>pO+SbNbQAx}qD3$w;)*%FLKC@H7$V>VyHsIPMu%+A<<> z^2k{b>0&A_0*U%3d`^MVsMTDQpX=h(cg1xCnV8NRZQRS5Zq1=rqv-D_7d_!oW@O@Q z1WrIcGIka(SU|ORJGb_6Pe$5VXKhdpsg0Vg_JixxZoR-G;I8QIkuMb#r8~tJuq-2_ z7a8=BLNTp{3Mp^8W=yhX4Zfpx?eW<2(Ty&fReM~IgzFRaiRNg+=#{;cWgY4BJBnZ9 zR}{tv&H>bruc0_)spg4mQI7Fwmb~?kG(i)TQxWnh3ulhy_+yjqD!Zf$9Vm^rL#U>N zlbEPHY=>mhuwM7=!qhO|4#BMy=@}v}LV ;o=xr+Mf1v5aa3o9dwa+%(fP95we z{`fG>vevs{uq{UaI=pDE=pDNIUFl4bO;TQYbDwn6_|Qz{FGEEY >4hw@CaGu$JMOW z2G`aJ`gDCZM4H7pk_WY4rT{RnlNo3XV;NQ(otLO@`O0%y>s`%anoTpSs5+XWt~)Px z^F3TD_^J0jSIQL0GR+nN0$STSY=?2VL80H5vf23`tLr>{SIAZ<;1Oz3n3##f6lbk` zWoy?76x9!h!Ih4ppqHj@|0U(MS$t)KC2L#6ZKrHa&rlE?LVP5IK2f)*-NN%;5wgTD zwp<`F!o<{fu_=ROi;Yg-T&Wfs!Zh^8Cu&+?NEg5pmeH7%{f*$7wMx@U0h7&qHgpYX zB6dZg)4`nDXhYpIOj%HivxCQoDAF6@c>W=bez&sf1PX{xAal26Jgu0Kl-&l|ES~ub zcb|rLXKjpuRisZoUjaSvq1^owT;3fWzBN^-W|@y$-`DB|Nxb|5wCS~W+y%fpm`35_ zuwV*5m2?9Res%#HKBypMYCU+kDZ8BoH}s(b^BH9Aum>L`v6VT|nK51qFDV&<*#220 z EmGYD7fqCdnLrjRnz*C} zwqFrtXe~^4NvFb|ps+B4bsHQQ3qQAl! CB*5P{zDgh`lSG~#|v-JU5I@HC5A z`Opm2I(;`GCte>`dbxre24t8)n$boey2m6st@om9ld-hK=n=%rIH<8uq6|26m%3 z(; +1d@&>1(VKMw=iXoZ>0k=RmC2 Y2}|Vpnn^_ZKT%t9DB%q^x!i?UQ$+nZIq+;JRVxD4JhgKyNwG*rnNaRbA?GouD?Z zL=&hBH2nF6ii$tF5@a 385_DUev!sEWW( *q&9^&UY#!+?es*(+pv6Ho?M8t-D$ zb>=ZNt01)rF`xbeMv|Friq_CZV)~g8EPKodPO*7jLacp#9nLQ+j9q!x4p{>jD);1H z@{+Q|_fuvrtD{REx2^IEwXqJlH(~TzSp;o0Z@TO0LXjLA!}_u>SyhEXIvQV~l=|EG zUR^3rMeXU@d1fi>Vlpl&y}W80?XAr^cCZ>2me+0>!lf0(D@1p=N?Dq2rR*j8?f$cM zl`YA0Yt!T0rSXJWU7 d^2%m)4%os_uDp-@e=HXLV;?Lz>g$ z#_