From f72d9dbcf165c572b55cb237e1479fec05eb43ae Mon Sep 17 00:00:00 2001 From: CorrectRoadH Date: Sun, 10 Dec 2023 19:23:53 +0800 Subject: [PATCH] chore(doc): update document --- README.md | 6 +- README.zh.md | 102 ++++++++++++++++++++++++++++++++++ dashboard/src/api/database.ts | 2 +- docs/getting-started.md | 27 ++++++--- docs/imgs/screenshot-1.png | Bin 0 -> 299522 bytes docs/imgs/screenshot-2.png | Bin 0 -> 299705 bytes 6 files changed, 126 insertions(+), 11 deletions(-) create mode 100644 README.zh.md create mode 100644 docs/imgs/screenshot-1.png create mode 100644 docs/imgs/screenshot-2.png diff --git a/README.md b/README.md index 7225f5a..c2e5b47 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,14 @@ [Demo](https://likit.zeabur.app) +English | [简体中文](./README.zh.md) + ## What is Likit -Likit is a backend as a service for like(vote, unlike, count) feature. It is very ease to deploy and use. +Likit is a Backend as a Service for like(vote, unlike, count) feature. It is very ease to deploy and use. The goal of Likit is help your implement like function within 10 minutes. -Likit is suites small and middle size application. You can select difference vote implement engine to get difference features and performance. +Likit is suitable for small and middle size application. You can select difference vote implement engine to get difference features and performance. [Getting started](./docs/getting-started.md) diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 0000000..0b8e6bf --- /dev/null +++ b/README.zh.md @@ -0,0 +1,102 @@ +

+ +

+ +# Likit + +[Demo](https://likit.zeabur.app) + +[English](./README.md) | 简体中文 + +## What is Likit +Likit 是一个 Backend as a Service ，提供点赞（投票、点赞、计数）功能。 部署和使用非常容易。 + +Likit的目标是帮助您在10分钟内实现类似的功能。 + +Likit 适用于中小型应用程序。 您可以选择差异投票工具引擎来获得不同的功能和性能。 +[Getting started](./docs/getting-started.md) + +| features | Simple Vote System | Middle Vote System(WIP) | +| -- | -- | -- | +| Vote | ✅ | 🚧 | +| Unvote | ✅ | 🚧 | +| Count | ✅ | 🚧 | +| List the voted users | ✅ | 🚧 | +| is Voted | ✅ | 🚧 | +| vote events | ❌ | 🚧 | +| message queue | ❌ | ❌ | +| requires | redis | redis,postgres | + +# Screenshots + +![](./img/screenshot-1.png) +![](./img/screenshot-2.png) + +# Deployment + +## Zeabur +Deloyment on Zeabur by one click + +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/KZOLHA?referralCode=CorrectRoadH) + +## Docker Compose +``` +wget https://raw.githubusercontent.com/CorrectRoadH/Likit/main/docker-compose.yaml + +docker compose up -d +``` + +## K8S +Coming soon + +# Documentation +[Document](./docs/getting-started.md) + +## RESTful API + +### Vote +POST `http(s):///api/v1/vote` + +body + +``` +{ + "businessId": "businessId", + "messageId": "messageId", + "userId": "userId" +} +``` + +POST `http(s):///api/v1/unvote` + +body + +### Unvote +``` +{ + "businessId": "businessId", + "messageId": "messageId", + "userId": "userId" +} +``` + +### Count the number of votes +GET `http(s):///api/v1/count/:businessId/:messageId` + +### List the users who voted +GET `http(s):///api/v1/list/:businessId/:messageId` + +### Check if the user has voted +GET `http(s):///api/v1/isVoted/:businessId/:messageId/:userId` + + +## gRPC API +Coming soon + +## SDK + +### Golang +[Likit Go](https://github.com/CorrectRoadH/likit-go) + +### Java +Coming soon diff --git a/dashboard/src/api/database.ts b/dashboard/src/api/database.ts index eca4ca6..aac22de 100644 --- a/dashboard/src/api/database.ts +++ b/dashboard/src/api/database.ts @@ -22,7 +22,7 @@ const useDatabase = ()=> { } return { - database:data.dataSourceConfig||[], + database:data?.dataSourceConfig||[], isLoading, isError:error, createDatabase, diff --git a/docs/getting-started.md b/docs/getting-started.md index 12acc3e..fc575ad 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,26 +2,34 @@ WIP ## Getting started -WIP +Likit is very easy to embed in your backend. You just need to deploy it and create the business Id for your business. Then you can use it in your backend. + ### Deployment #### zeabur -WIP +Deloyment on Zeabur by one click + +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/KZOLHA?referralCode=CorrectRoadH) + + #### docker-compose -WIP +``` +wget https://raw.githubusercontent.com/CorrectRoadH/Likit/main/docker-compose.yaml + +docker compose up -d +``` ### Create Business 1. create database connection if you want use extra database -Screenshots-1 +![create extract database connect](./imgs/screenshot-1.png) -2. create business by click the button `Create Business` on the top right corner. +1. create business by click the button `Create Business` on the top right corner. -Screenshots-2 +![create business](./imgs/screenshot-2.png) Input the business title and id - ### Implement the logic in your backend Copy business id and use it in your backend. Message id mean the id of object that be vote, The message id can be any string. It is decided by your business logic. @@ -33,4 +41,7 @@ Message id mean the id of object that be vote, The message id can be any string. WIP #### RESTful API -WIP \ No newline at end of file +WIP + +#### gRPC +WIP diff --git a/docs/imgs/screenshot-1.png b/docs/imgs/screenshot-1.png new file mode 100644 index 0000000000000000000000000000000000000000..6207a60498af7fb122b0f0e7dc76dc5b4317ccf9 GIT binary patch literal 299522 zcmbq*cU+Up(m#Tzh=2-+(mMh|=)I_bbdaj_E`c_#<#LU5-)5P4t)PmE~-VsB`!V;78bTl!uwQ!|1wXn1X ziqjvqKlZ#&BF0Gie`8yGH=~sVy z8PgJ{w{mrL6afG{JUlo(csU)MEdkuZ!omP99smyy2c`#yix<$<#FGQ)!tjg5UwKGd zxR^OxJGxps0BL{mG%a}}qj$Ixm2#@xcw`tRIJuU2Xq^<2OfG(IRh|}|MadZ8J+uzA=e?#Ww5#ad?`4=w{bqf~< zJGWnR*8*B&X8jw|+rQJq>ACs%0Nj6nP3IqJzw|*X_LniWTr8ZW9PBYOa{bHGzv}6Q z-QQY&ZQ5D?QjUn73D8oU-jl=J;+=_`oh!YBhMBVkMieUtS24gZb=q0~jmKYF|HDM= zFPani!$^O9<2MU}dG)W)Fbj>b7{LFU45snFMrQ%USei4&r1-a2`!S{~X)Pu7T3$+u z_O-LaJ8L@&EG)UOq&K(UYV?`h|HNcH`qql$2+)TX zAR^CbTzRew(DJt3rJY&vTrZ+9|HmVlc| zgej(^p~#OraccK%UtYavPnea8RIg^t#dG$Vh|L)OAdDk&U-VcgVD&!5OUh>hQIW5Y zcAk7N7Wm;9^lAJi?w)7pIjv#OFj2V1jNL=kXswHv6g)qk6@HNHf6#xW09s7>$;d^D zsI0lL3z8_*O(e~^$&G6o@$!W!G9a=7K`k?!JuxU zd-20mK3!zYKUiHQLhoXmZkRcRKNZw9iOD#2k;-p<@}uH1$SJ(a)AWXZtTRYVO7lJy zAch#wxA{?~f4w6m;7&Vsz+h-mzAT04F5R_TYLXGv^Wd_E*8=pn#R7zgJ_hQ00^*_`68b3KjG<$= z2=O2+(|_#1SvH3DA110=e!^@{PZDX~!(d?F6aQHH9%Jysz_9wp8wU|S>kp20iAs5g z+QmaQj~BC#K90zE$~C^)W?o2VeER5`WaI4!!FeEQliW2oStIF$>vtSSnlFS&PE-q6 zLMs&`M8xpG>_yss^&cFAcTp_+kinIZqTH_xqH$`~oU=K0r>AmSqFN0mq}CPw12JM# zXRE$7!9ISlVFVpgY$o{HE{x*`q4EBV{2rzIP1~EUdqPtm-Hc@mJU!jSlglgU9IC24 zoj*md(4d2}%lHy5Roqm-Dn>s+xL4L=9(=~ikCe&qd1~%%D_zK}jL*KTSeI+ANvOfc z8as@*IzMNA1zUXXD$?e1dX3e-b+NLtvU;dLR-8?GzV*wD)g)el8|=gV^Lu$1y9SLz9bm0H@#+~4s*1HaPnePCE&6vE+rued_qi1S93$nyrGL-gp$i~A2>%2c`HyBp_!wB?T;#}{@x9)k(O1T)J`FDU zr2FN8O;Gg9Cr^n9WYjH?%*VE@imMP5d28!&u%cPi@KgvNs5C3>(t%#9YxAf% zYv0vY(0a&5%C5z>uPIXKsvNoI+-eJ)AUPY<;uO0S+@=7krAXWdn_XbqRP20KRC+RNJV+VNUyj?c+;kM!8}O7(3Uw2QPM^@a7N?w?_N`)vDp zbBiLW(Mg1QEN?7}hy1djA~~*6u4&D_i!#mU%_(ln(5R8q>2+w*&i-giAzVJEf+jyF z526oIyUxA=G`75N#x-di*kK*m_CS}RRn}29F=|F~t)9-t%JQ+T(09iOlaST-aaC%e zaXnV$qpW!nW>jYW>vro&UEPsB%2v#6%-9J@%-zb_<8?bq-kcx;aMY56jTN~K8~38! zoHb&0VD4E**^FJxthh_K@OQEAz6D;TUXY-$&bJY1kK7(LaP%hM>wnfinY^ETSYB2h zU-sxNzpi-ARLwg*GM#Ci<+|Lti&>?r;;JSa#afG*&6$b@uzAQ_)2zj;)~rFT?Ed0D zE)2Tg^6KF$?`V?fvL{~OUvviSyxxAjb=0ob&Hb%vrfT$f<7tFiab9wa4bAyr?;z{6 zb?JE4XnNlFS7b53C#bpEp){!ehVNw1?!!Hv?tG-&bq#j@N_R=#~&}C=MZR ztEE@fyDF8NrU7&T76Dl=(qG`cfPOf*oq=n4YZ@0G(ik*wNBDul9ReZ)YVSb%ADh*- zvnUg4lbUaH-?YB1f13`HjQkpLU$!<|5ZMgv6i`nDO$Bm**AwIRWoiPON`A+ z`y_}YkmQAe1{*6sx0~K>d*dgk(ysGJ4+J`NBHzpk7%ZTg=`$rN>Z{Z8v+3-(oV+ z&#BQkk(>GZDBanx*U-e&K|xzq?*30ZmP-C z@N*PE2boAJNe)+Zcy?s?)rqd{_1CX1as8j`BHEIU`-W0Plinoz>kJt9qNhh86_;*~ z@?G&m1qX_P&los~Ia}Hm94@2pMumS4mu2s&uzD+Rq*H&gUm{;Rq}8kq)K}Kw&{+gC zn<|g%M%49B`RSz89q4L3pUk%TzAH0%IDI;0w6p@r^~)RWI*G~=z!O+ppsa4n?J6mB z#&=R&O=i&}Zm7TRx+r(g=%_!jH)_Cd@Hh-z9My)Z>9veIZjFi5s;E!5*j`mAw%~XO zPKr)AEalY{`2uFxXOX@}b8S%McX$J}G36IYE3dDJ`}?nTaK^a6xe)HssutFQ;!@$V zrn=6SjS-XX@AEOK)EEy4a^2zXtBN-Z?2d>g%DkVoEt=+aq6W>M5-o~XHL#DchKf=7 zA@nc~hvQ2kS{uFEd`12S@v1rb8j0SuX|0v`&FpeD=U^fI*BAs=_! zt6ttnc!OP;+0@tOy{h}Ot^$fT?XdLNKM%=#xLKpu)L^*C*^0UxT4?#$Vga8x)LIg3 zH98I1r}1fCY>AP$<2!Q9b+DQxyC4go-jYO*X`FmS)mbDgF`PSKmH5vV+xeu{Bm=fJyj@m<2C2u;uhS3=1g+$ zqUT};&AKx_KCA(WZ7aL9LDp^PT{N@=dIbj3N2f9%N!yKOczLiq!Bki_cd__9CGsK@ za<0vB<8pK??p(1vlVs=%7sWb1x)v`aLN6|086RqUUVT8=tltPN#J+!s_nItaRm4?0 zA&b2r=+5wsjL(q5t%5**jh~i7G;8Q4Ty?ECM=nT!{H3oqT=9Mx7S?ktdFdCLo;UUu zZ~Gd!p{|cr-zB&fD8rXB2tOsNYrnX`5{eVYq4?nT9X5J@&F2qfa9_NzaPWUhm`G5- zkvKLs1|C~vR!+}P8&p9r55qTooQDR%f`Zn~MnGwnaO(lM0cZdcV58w>WSicwX@525I-vXpw(u%!xmdn%} zmzNe1`~V0UWBJkae~S9oasRKm{PtN$)${zLzP47X4*=xn?zVqdtlzRiKD*DsC3R$x zWBue0`uw+=#{PHi`_9soM27vA`M)l97k`mVm>w1r?x5x*+J6}{ooPK9m|AMZ6 z+eJk4{fc6UGtc8cGp>K4@#nI5jH=mUO?h3Wl>dzh;LwiD%*?FHTKA_O!=feu+4h>g zJ4Z2THy-?U=lpi||AORm>?=e+7~uz^U%~5NY5pZCDJ`%etx!wZS<%gX`hS%D_N#Up znAPC}Jqm_7m>hInXX|i1XZjQlkWG*ApdvMzLyoum{d>#$TRU%8V_PAr_(*)wAd^9~ z+zr`-jk0!-LGGRY7c6f)a(od361J0#d;q;b+Fng{FjrLi`UeJD*XIVK{`+>sKUX!-0vH-VL>#G#LLk1OHBqSnHKQ+gxlMPm#+dqlSjfM+ zQnH_(ml^lAwJmyfMNhCyi8Lq|-86!o6Px<~7doWHYmAliA%p;suSBx_#jbtx+kghP zsCa|!K*4e{Yd*kSE?sP_w^inC%Ygq~&40A=KbPUQ{--+HzP8NQWmS3hq8Fq_cffo7 zmP7xAn{D?azC)D%5zyei0)u%VsjgNOZ4YDj|9l#MPUX0%FO=VTYdPE#anamhEigAT zI@Qv#=q~66Wl+XzlU6sO`p=E){qqIv@}Re-_Azx)D~by=H>my_F9l0^kKcY#)Qf}~ z%bqs2oZ#a)K#X$A+IjH*T*N=4zQ%x&+IY)#0&?>TFN^;Eo10YUwt_e6> za$apW*&OPlnkJ-;fDJu-$@ReN?SFnYg~Yv=oOoz2F*bh;kE#{-rRqp=jC1FNNNj=d zD$mwv`fyG8uy`%j9$zzW{^zO+V9=&jpXn@j8Mktf;GVlR)eZQRWM~>>c*S6i^$I!u z+l~5foz5%UkE}S(oM_z$VNH$eA*#g}V>cvmE7BtPY?RrJLH4H#Rj5^ozYQa0Ofq6!?O1Knjk#KuYbDce`+PS-_mC9{Rj|Z@}LHm zbSq7~4+)ldNK9-$^PL9EiKRev+k5(|<9^ok6rXiEQF#siCeb3~@>8y}08osKYjho2 zit2WdC=@N~=_V?7>mF?rIb8BT(wBNc)lhLM-WaDGTcDbppWYsUJux+vcB#pm^Yq*& zf{CsvVVYaKG)2=+hk>Dnr`1hFsxt-a_J8gt9YgV?`!s%tbjqO^$|LxL=aavP+H6Y| zA;xG!@dH0rj%O{15JX%c`T0I#a});duM>XK@c;7Td>mBQG!jP9fRW+#^8;5(f95-cgKwEKaTLc3mA>hwBv_Hr%v}eG zUhOKYtZV=oNE#d>b|=cGQMFB|Z^)f$^j4PQIJc|6J?F~jQ#AL&1=aYJMM5aTFr*?e>_3LspuqoLsG0qZ@i(q>_#p#NRN2M*A`QnF>Ok&NmJZyCwt}hGHKUt3b=y17-OLc(Zpe_z@wS5*R@Mh4;8ZGd+fr1EqIb>>_a?ce)CzN%z67NEjD|gt)$0e5%anF(!!}XraHsBS(Gb)sjiO+aSz`&{ zKpfHScnZuo*jfr4YB>j%KwWbt5_?GX$!*wWj8@BCwjz(To-zFA`_>7+F;jX$lyZ$~ z5$UAi(cB9RQaLZkB_!}^^ddX4vYWWC=#oT?F_LX#5gMCZ8!nMx3dJIz#KfC!XHv8D z@7&FUQP3`TE#rj?&QQ}=XVHiCL0v$?-tD#nv4zHpnE7tyMQ@MnW<&V2MMGu9c#2*T za@)6aY12`0cmUX(9{eXZ{ZD)-B@7$AAmg(<&=xtWS;9!7?ZooQgplmK{23;jE#+rn`&?51K;A(r{f0y3kLoB zVzfVCT{(G7b-o$T-!p3bjUhLjGY*@vx#H5%8#^p4*En+4^d)^*Kx`;%f*T5j?rWw< zAwzDBqWIU>y7>6D@;h#sUCm3;Jtos1<<`filGN;#nGOokbj>O~`+Pe0vfJ)S*{J>8 zn+9mrw+w&D#m(rA!sd$4)#_|)wQGu2S8ZUQbewuhMP#$KTGjL*kIcUnApNd0Vfy=b zEQA}$`bKZa?z-}2Sv+lfa5rL`jiA%Y#odU~5YhWR!t^^Zw7b@5sig<+4%0$ z++u2Zp9VYh>G~iw6#K-H@UE zJdi6*!xbVE*JRQVQ^T*<-?f#A=iw>vbEp!uGq6Y!G}6@H9fT?^FX;qWJo=9#TC9LT zx|Qlj$kUmF$EzA1N)3i73G8fr_B~Q>nxBX5Z}U7&$2%T|ekLgUh|Li2H5|r^a%%~e zs%;9y?W(63pmDcLcxbIV^;O=ub>z{ZD%JO>!{}TMGIgg@wEfah+Y=8?pk#x5%6U>^ zA|q>|v!b(ewWS%s+0nZeZC{->Zz+vBvWAA9ux=WL-YoTkLgNU=!a_j@E|)OYtUYIC z=X4USH@EB0p;AXoSl|AOu+$klecEwQ@^I?1sN5b7cRP)P$+w-$3eIzd+!Em{Q`ggD zmuEgQdC2ZA`9@xbOn+MnhtAE-&2WR*1M3Z*406X$ZzZ7BzsBMb_6-N~dQ(6Xramr^dsYL+Yszq@E>EMl=X^Dn1r z&s9_^&UWTy;|Ecsd^ZX6pDQazk&y1k`JoWhJ>Q-G0Y3SBm(ezsp>;CtC<0;~+PQp2 z(>V7HPH?!j%+dO ztGDv732K~qt6Tba9_9XXT3Ta;mJxb9J^{Wttcb;T;mdq{0zrnGoVAmVwbUvvHMBD2 z*Jb6+%JEt?_me&bZz>1^7n=LnMD-FfnPny?fpuB1f5V!b?mRTTQ zLC(iAMoDL9XYJYY@?kut7mjIMCYg~`yt?Wd8aVSrok4K2XSKOx;td8ZCqDuHASLug z`yt^)@xhV-Ez$Lc+F_%S*tPx>Nnlw+E9Bil<0YxYC`O?n-6TOQTfxp`hzlrN^YLLpxL(uN`3&Sohj{g-ZCQJRbFA@eu0Uw zEikEje2S43T+V9luyr_-uD4fy?6vk&yxy$*HfPmO3X$%mtn3ZoehuEi+8;wu8glR1 zNxtlcY69Mm@8;giy!q#jGk`(Cc%yGpfMjiHVtiQa@EwCnLPGpcjT{lhgC-w-fGjX1CLo)K;qcQF1`;NKMC~jDs00vpSlk)|6 zLqU$~IJxknBG50O>}`U*57cIn3pl~mE2m0aT*}RzMq5Y~b^#Q0bnynnm9a?)}*;(7)nbh1PI)ccB}S00=#Wpnb9|`h;aP z_maFQQ*xvG5fb9}gOf;C}d&bC5~MAZe7Io@(OblNr9-X8%F;{YLH$5Y(negW(i zh+q=35b7!K!AYYOJ%=XYHREN->b$y^7E{K+a)N`tPtrvo*8>k@ra$Q60bu2Xl4Mr0Pa!+e3tFL;LsrcaSzSl`vuhIm(G6|X{9&O2)I=|8wVajE__{?wiPzg7c zO;km>8m~vLF6(exGPzuLi(t0FBe|S$z1;ZLzYx9$