From 6ff4881777ba9e28e8dfaa491a43530a4fd16c41 Mon Sep 17 00:00:00 2001 From: Redume Date: Sat, 22 Feb 2025 23:02:49 +0300 Subject: [PATCH] docs: delete all files mkdocs-material --- docs/assets/logo.png | Bin 14491 -> 0 bytes docs/config/conf-nginx.md | 28 ----- docs/config/config-env.md | 24 ---- docs/config/config-yaml.md | 132 --------------------- docs/endpoints/create-chart.md | 140 ----------------------- docs/endpoints/get-rate.md | 164 --------------------------- docs/endpoints/list-endpoints.md | 17 --- docs/endpoints/metadata.md | 60 ---------- docs/getting-started/contributing.md | 69 ----------- docs/getting-started/docker.md | 79 ------------- docs/getting-started/manual.md | 72 ------------ docs/index.md | 11 -- docs/settings.json | 14 --- mkdocs.yml | 62 ---------- 14 files changed, 872 deletions(-) delete mode 100644 docs/assets/logo.png delete mode 100644 docs/config/conf-nginx.md delete mode 100644 docs/config/config-env.md delete mode 100644 docs/config/config-yaml.md delete mode 100644 docs/endpoints/create-chart.md delete mode 100644 docs/endpoints/get-rate.md delete mode 100644 docs/endpoints/list-endpoints.md delete mode 100644 docs/endpoints/metadata.md delete mode 100644 docs/getting-started/contributing.md delete mode 100644 docs/getting-started/docker.md delete mode 100644 docs/getting-started/manual.md delete mode 100644 docs/index.md delete mode 100644 docs/settings.json delete mode 100644 mkdocs.yml diff --git a/docs/assets/logo.png b/docs/assets/logo.png deleted file mode 100644 index ab98cbaed6a8e144a53fb1d53f4928af6d08fdb2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 14491 zcmV;MIAq6(P)K~#7F?R^Pg z9c8uuH#2w1)-+9;rY)s}ibB&?p#??c`C1S~p5O*3iVBMQ*QX$EKq*=jRCtQGptykI zUmvomPe4$_@&J{k8&FE2wRBCJCT;ecd+%)T{LY+jGD(v*H_4r(r3a?7+{wN3&HU!< z=X^>XqC*rj8ETx7@B0Q3)@sg@mH(p(B;R$vzxJCaJWSu=t3xy{$yDQr05rX3Utki2%!Q|$<6RTFON-SKs&?WHsbLPz1OU!=tt6z;CGla7q62~#ocmf?Oa|Ad= zKrvfdS`sy?aPo3p$qgGel+a?=*VlV@-F25o-`D4yM;>{^tF5hNK>C3asSZ(mG@d}m zx*TyQqr1D?v~Al`!yqr$ovf&+NOg5}8Jjk3asjUApMPG})zvX4YierpRKQie=H_Of zKn~pTu|wQ09vU|~oz|}i2!`W0hU>b+1D%~o(%+VrmzSp}Oqh_)X0yD`WHKeRouX5) zBx$kew^;XsNIwL)_-I_nmDhgpnR34(SLb?(BURp+Y8Y;v>pPXERW@H0NOtR%$9uLt z^Q@Q6xD~S({l(`Y;$IWIj24srCp?=8Wmt(|n?7SVjVh1~kP1E$qHwv)9FY1((lxVIVy=6?J!s+nC^R9eyif1N> z{Tp-D_@EJRx?Y0N4KNbiD%`?g&mbEm`^1(Xoc3NE*ZNCOPmd}qD`Rd(55lE~;}ZCs z($Z2JYXA^_!J&#+0M4+zWh!RFA=~uQMKAySya(yJc}$VDL2F;{W2|_Q$hYcNR#v(l z9UZXL8~~5T${>{ShTlCRPN#45YrnE$u4^V28)GL*i$=`v7-=5sf4=C+J}h41bmSA9 zfYWlhoFdV}3msFm@6y}O4}cuq`PSA}fY67?DMYjywhsRldIkfM~SUno6M<8?va5e!C=RuE!QQ;xN)Sugp1ay4o<}6u$78x`jJLm&R zhRGxL$psUPmG)i7A}S|P`N?DwKvP%~@f%KL(*v*pLT~}vcf=v>4JG_G`^r_{rBjbp zF;af_#-D7taD$~3^`;PZo9pp2FhEMz$FLZ_9`!%5RRMGq%QpC#}x=wb2w zj=cSY5?mt$xX-B=DZgjy9R#>v(q@{jAC6Ltp+wd=mZmZA8lTgcXqCj+pxc5A;%i_? zuu*{>7!v(e*n&Bo23*79<>%3zd%t=`l12VMa5@`6N)yl&h3-6Bdy+!ss^Eq8!3`+< zX3}CoJmIg&ip6K{VBapTk)@|Y;KI0R zacHs0hv(4Wxp>hU8XEYe8Ype75YRE;=6?B+IxAgyu^;DM8HeO_?oz&;$Ad|e&IaWU zqSgYpQ{aKNjR(RH4nT`?4RR(A_?@9^#8*`+CIaA^9=P_>%=TxxurJqXXz(HVLO8kR zd>V8NG}7sEq|0S#{5b+)zM`VSuBoYUX^c8;Y%in?33QsnAsfR_pLH=EIOwd@LdflD zhd3gaNgm2HSei+|Gx0EJ?b5@+gYv-Tpu54Mqiqw`>tNrBAb#ww5#Q+o;5yg-d8d9U z1Z;X+15O`f1Bt+8gJ_!q+KK^3uAvu-6 zoI%-b+m-L;XuAhsOVI-0@j?%P4F>>@_APoq7I8XG(*iKDMh;*9??n(_#q1i{v*NC+ z064ub;9>^T4}{F!Xn`ozfXfk=%VJGq%u$5GUa(++OJj32ha1cnIV8~GZACndEVuWm zS2)>i+mvVbK#f*j0HOqOFgzg!odzH*J6c;vMup`{iguVEh(NQiPc6%3HAa&R~$j&7nJdeO3UJV)Wa9EAa0F&um`9QOJ9L*jJg zMK=vA^@`_mxm_DLT}tVt7k=1akU^!xq6CEE!!qH?2k1!O3IAsH70cfhH{fzDo9^Cv z+XcVWViY7gsOC=kxG%>5I3Uobb&fb3i&Ozz9^o!>jkr<(Rd})@U z%v$vdCcAZOkO*p85#aIjVUInc4obKhELnsqw3N{2APGQ!-?2+q9bs6;FI0@=b~Qh~ z<(Bu|1TLnn(FnIQBHT@Bz^T9z&jWDK;jkvxNRC2YFd`gelpu{s(zb@=)7Y=|N+?#( zmsg*nVj#PH$Bv#|>vwc-dTNK;^kP?8!&|3T&p+qi)ff{S53Soc#oY{3-7N}Cm>f@q z|4pBYe*iiHAwN`rkscNT<$hIF;0bx5{{Pjxw)a=sjMX)=`R*@Xr}u@^`Fb5aRn}}c zzzw1TE{8R9IPyE@$t~i*N{z&lhwMZf6m)n?r3TfSz4%M@#f+^2Y%NdyW@X2UI~%c& z2L(m}&=vAMx!o^s?t0H%I-VVHIp%NxoB_~@n%3)WkCKldxL(77 z3a)~z49M5|`g*l9RdtUMqot~SacgM{ zAmbv`b#|Wk&HtjC`Z^U80dS23xYlRy-x(35aDn*!_aoQNdYl%k02~1gez+X@;lSmX z!|8-nRUqw))2ZW+Ki)k0GyhXGzntCOx_kRQUtA8ZrUY?L7dt)9KiIlFyP1~68hrm>gwPcahES& zJ}kh22IO?Qfen2*z0YQaDiXCmaoay=rDJz_8ZdjfRp9B)7s~0BJYWt>8K%p+mni%m zMG>;QUQ(G&PYs#-Iqf@0M%p3ZpvR$#EUX;!4Tw+}4F(c6-N2e)PC;W~7lRT2&ba8V zPpD+YWhzGM-uU>pcK`FX4bc!>)QE@}5*k44`~~2&;Q(J;cXxNLwY8Ofac7=+X4Lts zhC>5_4uF#eHm08}DVlFCv;MJW0ECD`D754-SjG2-?uMCg3;IHn#hDH8dcI{N4au~U zl8zLJMOdKumX}q}_BE)HWo|YQ!Fb5Sco4D53)jqQ(W;nVKxb1y?i|zt-o}`a*r-HY zO?m5O4c3IIOI3`N-MRL*Ew^9tXDvdbPTvR!LsyAJ8`w2Ml!YHo0LKh~Tq2xy4;^l# zh3SLkt}yTdN2Xb{IBRD2rfwQE57Y_n4wP44(u5L5q2krFT=_1yyre8|CQ|g&J!Bw~ z;PryE^C0zzz!!*4=xeD-hpWVdzVB9c=Q=6M23Vyi+b~6-_TFAVp3hVS9 zTu03b@0(se_l%qNDikOp<#w+7<<{FSybaqr%FsVeNx;Z221F`dFI*!Ksr>S1v)LTQ zjPoQ;^OGk}cHsP7vu2GqQo!*w4RDNKVv3^~y5=+#dvr>mL8Z@?iFLGGLx zTB{K<*vb|koffU&7+~LS^>Oc-I_b^-`2)jDPLB(46sG(0mfJp}0mq|^0DO09!t%CqgjRp<$U^%#t4fa1-M$tH3^+^{^mpn9BN;(~g-#*?p zt-?5+!QvG+&`TuCTtiw%C|XPclabU*i84}HN|lLii#VcVtDbGol1SY`y4+3zTrw!s zP9#;R8!BB%EdQAXj0zU1vLM4G)a$DL?NdwWJEp6c2#J`DzrX6HsKZy*UOz{$k^sJT z{@P-xvREa+<%ql4M;&#Pyjpo&h{9 zT3IL5g*p-jLxGA4+#?Kjd63@BkKO(mt90UVO2s2q;TmcF%XL@fcdhM=SgO7l4t+95 zBuSI68#*vJ9Qoq1uv7s!g=kqzi%sekSFZV^oIJVzfWPBpRFNoAUNiIX5B?l|N1zwM zbI+p-05|Ms75JHwrYD7$p#>X=%A|0;67pUU;L_#cVx#~>IhGVI$iPbm9McR82_@gF z0#3}FKrB}W>%%{M>xa@cN1i>rt^tLUcK&v*{d1G*-0?y{rbQWfEJQsZnEJXjJF ze6t;_qkk=&Du^f~0x%J%!09Z#0Bk7@xG3mSfqrL*6>BEK=!6EF3Ph_n{hePsv1Dq) zhgDpbgYR^~7l*t!arj1G*pS;r_aj*&oTdb491<}nO`4RaNJAcgLz+?{@zg?SFVG1q z^>z13Khx2oicG1h!;hPO*4MvS|A~9vJ9*K?M}}|K@ZT^a!6H`nA}&#WbJ^JoaVvmI zl!%xuC*bvRJ3bDsXa(HP6z~OHkHvM=8SIw6dSUIv*{6M(e@Df`?n=)Z430*8)Qz!^(|<71l5L znSBpHb;xn&<8!@#VLtb3deP4Nepj2~Ew6;Ok zt`2X}$4FCxSk1xtOZzs`lmIwnjT8%TpaHE{olZ>_jNkdht-I-I6iu%ih)C>Jr6j^TUr#>W|ALd>5Mt0 zwP!58o;YJ27i6pAOV+>_cfl{C$D;0#{+6nU)X+5|fXikwnJj#9I1cBp08SN?1_E7g zW}@V|dv8Nk?~}!#U#o zWx&C3sI9HdlOxzAU)-pKw}wi4aXS1kfQROH2<3Ejb$K0Y?tfMtAe2Z?mp*htCD%%fEx&YwZSBA@|dq58~J=t9f0?^o9>H2Q{MKSRCR+%-cVG zDUWl2>U-^v(*}bIfX6|6WQ>SwgcC74J3I5u&CQ$_M}R|KTw%!-BcMV3bdNmph~L=Q zh+bsguE%d}@$%gp)B#9v`l9t~vg$BerqlLB&K6M-@a>B~N#IPrERv=kx?ps8thhXm z^WyHi_R`$;HC+S6QFZyC&KeQmAwa`fzbJ~<91cmD1U4wY?2A(|(>|TU6bA9y+uK8 z6gS{NgK|264wXJAJR$v#Ghe&cKlY$HD9H#jNObyBuj6BU0FcyzV-I`(&F|GBREM{8 z?-BeHwNzD5OcNRnw4X!Dxh{&9M$}_6xWO`q*_wb}C!Kg4dPCgi2d`aER^emnpe3VM zN8`?$LHAAN`(m4pEtMTU?}D<1x79_`l9(c)FTWq)*l-}O$Jy8@iiR&v^`?-G2@NV< zVUcMOOW_fhd^#A2v;N2L{Jod&X;cR_1#S{vdqLI`Cw@ja-t$b8y)~*# zk>)lW2Zk;uOI}I_k*35(gUp3C>OuTMXwdn$!0i?-TEug8A%mD(4*5O`iOqbjeM9*X zub)e9gHknq3FTR{)JVt>v5S;;U;Ft21<){*ipLe)m&`<}x^nhul`gvI-aeptV9N|bKG&qIrraxzem6u^I0GFRf5R<#h_?H@x?sr9bkSMK^4g-+#g2eR zrKNwAP^_aox3}0@igcoeNL+#!e!DHd{?x}a+n?za0|Gud#85K?x(pq|8gbPexkj9U zCJ`Ac+HVr4cArpK%tPHH>K|bZ(SYpsXYbv$`A28{D!X&t!|D}4a5VcYZSz4Dnd?Zy zYi)4gtazR)UCY$z@A%3`qSg9R@ZIN`q6;Xuc^d~DPScR)R9&`gnfmKr|EivN;t5q< zUG4ALvj>^J22$El_u2jYeVelF+gDf2dgE+zz>XI^Z{#}N0EA$_B90f7F8a~zh>+Q7 zeXrPLl~pxZB@|{N+>uU{5=FbSV)NF^`J%)l|;nK zkvhYL9!-C|YUPF-7TwhT{GT51o$NseK2GMO5SquF&KCX7>DBf8UjLpdvST?px&G|K z-t#RKIALB37<`ymgh5BK^AxxpJ+B1ZU)-#GjJaJw1tAhR` z+!7RVK4dfid`KAFb^q5^y>Q)|e%kWCH{G4xwf+TqN;!3qkWo5O0B19&3pk%0%%05v z^ulZa&S@#)qn>c|qAOBUXIH8~PfyY_NP|?s?UJayp@@Xlzu)m#(6BE+Tq&4b*Ti7R z7nCG%n5Zg(=VTsp1I)2^rV@iuINW-)LkY6k=@?NdYy`< zyqif`C!~7JRE9EDu@yWw+p%in_fEsqPL7s1wDgdHks)2L2a>6=u~BCUBYI(sg&So= zpwrvuo_nsjcI{dVx&ysoR!d6@vv$(;pj)7$o}Oz86A)mHRwW6m>hRLaxn~?+`KpuZ zlhre(o2iNkYV;@;(0O)-I|4+TCYoGZk?d1BrhD2I+m)Qzy6T6Ue|6Cvk(yRWp9}%7 z2Wd@^OsL$~Au%-uLI2UX1NxaVbi$ee)tp%=s@}Ae+3&Fcmg)ArvTSW1U0j|=$pY; ztViuRT}^+w=3^btKd@aJcTjog#Yg>e&*aIIvsG19d4$FE6z_3!yHR`XqOk} zj?IwUaT^OW;CNv_6f@}Xj~*z+O#E~+?W;Hb;H?)+B|i$PQQyj-qd062ybbU`peuT$ z`YSfzjoNhT^0ojloHm0_Kd_dNPD6usXpr#j0d$CF@U)F|yo7E>0>@!>C4!bqJSPJ> zaT-PLE-+dIhHPg$Bx~IW+L5WiX0_Y4ElbzbzurigIuI`;Tefo5t+$cV&Mm%eyge+nK-l&02$PYw^uM0yk7PwekV(TWE?{;Tr zCnoqvc64-r`yq824$Kse$t*Lx(9J>#eL+nTdv>f{@8^1QCDV^Sg7m|pwK(ff=m?+_ zK4GyMl8@(R+c$0f^(THj{axRDxop-OKN=Krn?cdHQQRk7I%DpIm2*!2`<`d++a7VF zxZT~|UPVQPM+OBiD8M4=WDaH0U_cFD$wcWIh zB9kuC`#MO`?I7KwgTU8`g}7h0nMm7({H~j6>D>C;Pd%~zhEsmK=kGs%2tDWGAk@Gr zKWwcR{G0D?Y5e_V-=Iya>E0#xJ6+9dkejC+$9|ES3K=mKlTZ8dHIiWrX#%%Nio7V8 zN{Wp+dIpKHaHA9jbebXxDsw&pAIjY@OP)P*=1lnOpks6s=(XA+7Kc?hKxQF(F%AVBxAhj02~qM=3M#oc@0Ze zo>j=-NFfOF^Z`H{4(20{I3inLU(Wy}aSQI(O`NaGG)oEs9r?mMX>{!x=o?3(3>hIk z+n-bUJ)2c=Nt_{euBCa|jn`+lJ-1s)*%%UEyZ-g~?(X$}|5=!g5|i4Vt~>g|Nhe-aKQ38DBLAO$I3Ykh$g6qNh1aI0&YdWp z0zFG3{HV`3)>)gDX~XP$Ve;)4E$aQbZ~Z{HQ4s|4E2h;&vudpvEJoQyrQ7 zc}Bl!IO*LeSDx|yhAWrS*0Or$*aKJk5n9M!GZ-=v6BJ{4fv~uE1!G|UCk-`IBN=hzIg7Em6y!B^2s_3 zK;{@Tq{6JvoR$3vZyG%1WZ@QGu@va>K}D2hIl9A=3fp`ogLLyzCNJN!wP(|+7eu6j z7*WFIm}EvBE{xvw;5Q!6@7{bj_Tw}gCm#Fm%Sp^uLd-(H1BV00gP0}PNs8Pl2?C%g z&#Gv^8xrU=$C~q{Wp!$Zvs=?$KgBbWKf5dcAD7(Ta@(m$PZ70UkG6`6#Hl{sDUTdXNYDXE#4SrNifgVl}M(frKZes!+lIj zc)F!gBhSeIaM;Z4e5nVZqUXpKAnFw~cT)k^<8*R8_g43oReLg-f&D6s5^w-^#Joh(O z_nh)=#6%MSpJwH%H*uhVtJ~{h``#QsPziL^exkCVnLPLZbIO+%Njcl@ZsAt7s8t|C z!tlKCjWHq|kF9H&zB0G#4_7?unRc{L`PS_^ zu6Q>#@5UWEX0w5u55d{esmCbpxI;P?2O{Agk zri&%?}F;ro%z_FXYOs331d7dTXb7n zTOC?F3R!B7?G|%xFc9lmvp@IXkge6xB-1eKO{-*qnJ7KFkiSdS9gUvDpKMtCA!fDLL5+|Gn!F^;1Xg8}MqjKJk*rkdMD!fySw~`` z%(m5=oz7ioSi>_SYS9Y7VG2$a%o~Q#oGo<=HufSI+Spgy3}Up9O3*of5wjflfFcfR;A^f^NSr#mMx@WAb`kT*h4 ztBxuy2Oym?Wr~Z)OaJe*%9F8+S)*6XnmQ=}DNwYA(>M(y1JMdtvyv1rBH;A_9o{y4 zp1vUGZ8Hv)-79 zS>)bnF-wP%I-47A6apMOjgb^E(xlH2bU-dx=N-AXpGB82M;)Sl5^*`@=X#=+olemQ zX@{^jD#9cNh}-GYr}KF-%ivzL?wS++cPzv#a_?$S{`jjSAu=Qcq>0OM3KY3hk~3z^ z7;&e75Om;jK(Lw5w9vh2R)=U%LZ3RjbsGvoua-m;&lPJ+yGr zzrhHcGikUVRWVc0_l}bStcZTcMg_zy`4^GmZXv}T=ljEmk?B8F=;%Y?C(h?@f9Tt- zFWqp;Z@RZG|LrTH#cKfsJq|rf065dIw3VvGrzYlflDNrJtixX?J>yUvr}hUr(CV)p zznTQt)hcF6)*Nw8?WteDRPbgpAgEyE&%WdmAP0Y9J~C0|J~5nI-hlm>ZJ& z!2_ooOrMJqxZS#I7FOuFtnOu2io;f+)@HdPzB5&4Ea@dfP{+z(1$mB)qQzams6S z#Y8h;xJ?jVg8p~@`RBVjO@F_?O;RXf*zcj!V{J4U+8MLk0zQ;THr8L{pG?>V}2lPt%aQmDwXyI;6}_l6&yd3WO-3- zv#MwNv&bX~LTaY8i{QG805rnsv?Uw$(QyN65>Kv(SMS9aU-a(1_g?lC4CVI$%xAv- z`j=hbi(kw}a__LfUk7UzVwUg`CIv_~_>j3>pX>qMeTi6RV$!5Z+=B##8!(lXwD}@X z!egB%J9<%V?a7~9n5wCtr^Y9ZxR;63-J)_$>$#A+w=qsqCLOkvmuY)(+Z`8QuOb0{ z)vMoeT`%f)iP5#u%iD&!UJ^|`H{N(7I-VCaWjUTv!&NJn(J%bFijlaB`)@w|F$(v! z%j9-BQXR6Ser3=N6Z>Qf2%%n!a}@af{}JICNecOHCf^ec%g?i3n7cyC9D2MTMJc;ME9s` z*8qL*uwbGTOk7N!52Wnt3GW8Y`yOyQb)~1_@O^K^iWQjVhg*H2n|f_+E#x@bK6De{ zy6DHcXdgE=gI1$-0X;}mYlwTn@8Gx<~+k0YPet zqWfpSEk$BT|6RcpIE}53#x7S zqI^<~8hzS}(|NfrZY|+-?dB$io`)A!&zBW6G(_cC04@QasT&>kPMfav7B|znZtH)4 z>RQ!117WDgAyJdo-~bsKcNYP!lh!@e)zvv9Zjy){b^$J=P{Wdy=q>zR6*FbFuKvOH z|Ni7%sAz*>0Y(FEhxW3VTZB{y^rdl#IqA7a_IkO7R0OJ(URWoz^3cH%Hx2W^6X@{d z0IEEh&q*ZzN#)PqGEx$cOpKT|u@SJYDFrneJnq>8n6H2EYQ=KTQ zu1r);s~#2@NuP9`e4YaGjlSy`UXH-k)24V<0nhfsu6d-DdHgb&Xc!kHDFSflgA@4S zXp0s^9uQmgjbI8yUYqoXBu=v(El8Gw4kvkY5UZZ7;h*#Ao*=bJSN)F)iTZQnoU2w= z(SVL5wr%+Me$TOJ%n9Ff$!qP9;^|t7Yl}zkx07X6$h$KnMCOU_4xvDd7ah6aa`Oc% ze7UM0@P?Hopvw})KVuU3Ov$(6ayBJRTCfcQN0gad!Zxo;x^1d}4RaJkMOgC0RZ0>4pks+{`Dt*o87h=mbA{^(ws{IyzYvnt&h03Yu zv_=gCZngv8T+mR|;fa1R&j#I_Zt`n&lQGdPdXFRBFV#p$*Q6eQ{PBq$J9Z=+8yjI! zV#2^O`V6jy60K{iK;jrOH*9}0WTIj{cdVYKJ>1rx>FL`M+LL>!r*sJ2D3}C~B%uvY zh_sjO1G-_AyGQgs?mq%YCm9?r-B<^`=g{OD9FB|+&QiedU|#@eNxxy9-9`Eg!_<~p zec54cnn4GqVUYlXOaCOrCtRKGFWylN6{vE~1gL-LUBm`pp4w zw4IwaZCaK9hi;oNGCIj2+Cdl7P7esmFPa{<(M6*1AvjVet-GQ3&~`=z4%IB_Q^V?X zLt-z?&=oO1@QU8WQ;o}lecKC^J^a01Y<&)@y5ziYjo%W-sUyv$ zv1ah8pd~Kfa7^S!hQzQ8h{4Aj%s`GF&v@zSg-1F(B1t?J71Y^keG}K@%ZtG;kxbj^ z%V#`qEY8RA=w|{1gHT#BzvOEr=F8cPnIG!K%Z#EDE3&;*WmkvaK5l9Q>L&5 zCuMDpJRHOzZB#?SX(|dS9wtxMuH=DDIP&!q%Z@m{;Lhq@YyQ02?b?A>Tn@m4-<6;| zzSq$iysB^Vr4b2bg+_q}l3X)HB0ofg2{9!V_T{^L(wZ8y$uSj!HRKEw5!|vlkQ=W zm4kUA1LMN;5(pmCgGpc>E3~lkQ)O8-3?c)7K_Cl@Q(eu4biKF1rXbq;WZ6ne<1 z-uNlsaH)U5-vhVcTzpe;)3r-P^5*bc28kH}mW!(q=%+C;5b0rfF!I$XlOfY*f!on< zImi@hYilzJd;&kYjE0ydJ@0U7zbUWA1O}8 zclq*QeF7Z*md_Ke$}a%DWSn6_FBT_o_J0r~rHG#GkzvOUYW)I%dr3b!8!tWP>eYXT z>&CqRm~b51xIg$z?vawQ^*KLsOgA-$F6YpF!pjwoi_|XNQa03Miw3$VX`Mz-lp#6@ zGL=1g6L_*>%)kt82a$$!?o_HguZBTJV1RIThrETjp;7Um9k#yQWCMU#0RX{?gGtYV zH`kLJ%*8c2&Kk_~MsB}c4j@thk`nHSeHpVZ*kRBS=W!7RLkoTBIy&kcPsZm_)Pt?3 zuC6XVhOVZxPQt)YLE~+H`nXnzV13P+z^&xF!q4=1(ewLldjK59O`Hz8C1yhRBul!_ z_s0S{O&WZ-;o9L$Zvq!~YY@`MJ~>h?GgUGyL&8!CT?)uzK(l>$YXKqvgTqizjKK}T zo#>cB3a}v{!ZhR_Jv1N5tk6*qQ2;?dm7ntI9H<9A9&SYicferqVV}UoV}UD$3@S$~ zd-$=u(Xd#^bo? zkjyE;eNH&x1W#A=t0Itgp&&Ps7Ni=%sPo{y00;;mY%S4s8j<^NKy`>(mox@_eIZB0 zIj8~y$n-dsykz(sFDQ*$;rB?F^vQ#Pm(7b@mmjNm-52Q#k#%SxB~5Es55_e-tiC`U2oJbaFbk)D74`8F1MNH%8uftMZI zm}D8B;~4hoZyg-Nf@9c6vIG|BvXN;ni^Aoiq`4T@_-&bHlP89zHD52*bPBI=9OKg0 zj%_9V^z`4zm~6d`bKo+1g8P8i0ec}EiKg>I}BNf zxD)mTp78U?pA;QzqfPzqgI2_&qH+L=h7kv(F&D3zv|#}e(A3nVtQ{}xHp^=NhBuL z`QwuM-v>RG{iq209qYK_bO0WL*Wh$yEtZmUUrH8H3FsRV0N<1=Z;IOassn;OdA0*6gV#lb&lnIyyQ~$;67a=qU%J7(CEu+~{;lUI4Oy z{IzS>B5Hu1w+1Qvt`z&4)hi>36L*~h^{AlbH zmUt+q{*W^hm2N!sC(L{mlRM)OjU$~-EFw0?WhQJ_X2Q;sMaz{&s4qY@6>+>gIVU+= z6@@^^(I@cr5ZJKI^|?7A1pj59`~8ADLJvew5kv|Q3zeDw)FFz8#-;MC-6yiGqJ1&| z5O6{QCXQK{s}yPS1RfT_2=x#skzV6#ajc1svA##(Wv6gsW1|Dd>9S?Z+ymLQaiGz7 z(&<8q>Q@7R!2n1AL~5w7elGtWX zy^fQrLx78o4pcXRzHZJJLwXeHWhfBRxo{y7xb&t^pCe<$L(C8rZ8(T95r5$!Ln1aB zmz-`09irir-#cgQejB(Piav}j{U1*~s`--pfcyXe002ovPDHLkV1jZ9;n@HH diff --git a/docs/config/conf-nginx.md b/docs/config/conf-nginx.md deleted file mode 100644 index 4ce05c8..0000000 --- a/docs/config/conf-nginx.md +++ /dev/null @@ -1,28 +0,0 @@ -Kekkai is used by `Nginx` to redirect to the correct microservice. - -## Change domain - -Change localhost to your `domain` or `ipv4` based on your needs. -If you need to use Kekkai locally, you don't need to change anything, - -??? note - ``` - ... - server_name localhost; # Your domain - ... - ``` - - -## Change name for SSL -This is where the name of the SSL files changes. This needs to be edited if you have a different one - -Change `privkey.pem` and `fullchain.pem` to the names of the files you have. - -??? note - ``` - ... - ssl_certificate /etc/nginx/ssl/fullchain.pem; - ssl_certificate_key /etc/nginx/ssl/privkey.pem; - ... - ``` - diff --git a/docs/config/config-env.md b/docs/config/config-env.md deleted file mode 100644 index 793bd30..0000000 --- a/docs/config/config-env.md +++ /dev/null @@ -1,24 +0,0 @@ -Kekkai can be configured using the `.env` file in the working directory. `.env.example`. - -`.env` config is used to configure PosgreSQL running in Docker Compose. - -!!! info - If you are not using Docker Compose, you do not need to edit this config - -??? note "Example file `.env.example`" - ``` - # Connection secret for postgres. You should change it to a random password - # Please use only the characters `A-Za-z0-9`, without special characters or spaces - - POSTGRES_PASSWORD=my_password - - # If you do not know what you are doing, then you should not edit the values below - ################################################################################### - POSTGRES_DB=kekkai - DB_HOST=postgres - POSTGRES_USER=postgres - ``` - -This config only edits the password for PosgreSQL. - -Please use only the characters `A-Za-z0-9`, without special characters or spaces \ No newline at end of file diff --git a/docs/config/config-yaml.md b/docs/config/config-yaml.md deleted file mode 100644 index 7daebbe..0000000 --- a/docs/config/config-yaml.md +++ /dev/null @@ -1,132 +0,0 @@ -Kekkai can be configured using the `config.yaml` file in the working directory. `config.example.yaml`. - -??? "Example file `config.example.yaml`" - ``` - # For more information, see the documentation - # https://kekkai-docs.redume.su/ - - database: - user: 'DATABASE_USERNAME' - password: 'DATABASE_PASSWORD' - host: 'DATABASE_HOST' - name: 'DATABASE_NAME' - port: 5432 - server: - host: '0.0.0.0' - ssl: - private_key: '/CertSSL/privkey.pem' - cert: '/CertSSL/fullchain.pem' - work: true - log: - print: true - level: 'info' - analytics: - plausible_api: 'https://plausible.io/api/event/' - plausible_domain: 'PLAUSIBLE_DOMAIN' - plausible_token: 'PLAUSIBLE_TOKEN' - work: true - currency: - chart: - save: false - collecting: - fiat: true - schedule: '30 8 * * *' - fiat: - - USD - - RUB - - EUR - - UAH - - TRY - - KZT - ``` - -## Database -Kekkai is used as a `PostgreSQL` database. - -!!! info - If you installed Kekkai via Docker Compose, then install it in the `database.host` value of `postgres`. - The rest of the data does not have to be filled in. They need to be filled in `.env`. - - What should it look like: - ```yaml - database: - ... - host: 'postgres' - ... - ... - ``` - -## Server -!!! info - If you installed Kekkai via Docker Compose, then changing `server.host`, `server.ssl` is not recommended. - -### SSL -Create a folder CertSSL to store your certificates -```shell -mkdir CertSSL -``` - -Copy your certificates to the CertSSL folder. - -It is recommended to rename the certificates to `privkey.pem` and `fullchain.pem`. -If this is not possible, you need to change the SSL name in `nginx.conf` (if using Docker Compose) - -## Analytics -Kekkai uses [`Plausbile`](https://plausible.io/) as an analyst. Minimal data is transferred for anilithics. -Such as: browser, OS, status code, url, where the user came from. -Most of the data is built on User Agent. It is possible to disable analytics in Kekkai. - - -??? note - ```yaml - ... - analytics: - plausible_api: 'https://plausible.io/api/event/' - plausible_domain: 'PLAUSIBLE_DOMAIN' - plausible_token: 'PLAUSIBLE_TOKEN' - work: true - ... - ``` - -- `plausible_api`: This is where the Plausible instance is specified. - The official instance is specified by default. -- `plausible_domain`: Kekkai Instance Domain. - It should be added to Plausible first, and then to the config. You can add the domain [here](https://plausible.io/sites/new?flow=provisioning). -- `plausible_token`: Api token for authorization and sending requests. You can create it [here](https://plausible.io/settings/api-keys). -- `work`: Enable or disable analytics. - -## Currency -`DuckDuckGo` (fiat currency collection) and `CoinMarketCap` (cryptocurrency collection) -are used to collect currency rates. - -??? note - ```yaml - ... - currency: - chart: - save: false # Enable or disable saving graphs to an image (Boolean) - collecting: - fiat: true # Turn off or turn on the collection of the fiat currency rate [Boolean] - crypto: false - schedule: '30 8 * * *' # Currency collection schedule in crontab format [String] - crypto_apikey: 'APIKEY' - fiat: # List of fiat currency to save the exchange rate [Array] - - USD - - RUB - - EUR - - UAH - - TRY - - KZT - crypto: - - ETH - - TON - - USDT - ``` - -- `currency.chart.save`: Enable or disable saving graphs. -- `currency.collecting`: Enable or disable cryptocurrency or fiat currency exchange rate collection. -- `currency.schedule`: Currency collection interval (Configurable via cron. - It is recommended to use [crontab.guru](https://crontab.guru), not supported in `Non-standard format`, like `@daily`). -- `crypto.crypto_apiKey`: API-key from CoinMarketCap service -- `currency.fiat`: A list of fiat currencies that will be saved to the database. -- `currency.crypto`: A list of crypto currencies that will be saved to the database. \ No newline at end of file diff --git a/docs/endpoints/create-chart.md b/docs/endpoints/create-chart.md deleted file mode 100644 index 059cd99..0000000 --- a/docs/endpoints/create-chart.md +++ /dev/null @@ -1,140 +0,0 @@ -Creating a currency rate chart. - -## Creating a graph for a certain period - -### Request -=== "Shell" - === "Curl" - ```bash - curl --request GET \ - --url https://kekkai-api.redume.su/api/getChart/week?from_currency=RUB&conv_currency=USD - ``` -=== "Python" - === "Request" - ```python - import requests - - res = requests.get('https://kekkai-api.redume.su/api/getChart/week', { - 'from_currency': 'USD', - 'conv_currency': 'RUB', - }, timeout=3) - - print(res.json()) - ``` - -=== "Node.JS" - === "Axios" - ```js - const axios = require('axios'); - - axios.get('https://kekkai-api.redume.su/api/getChart/week', { - timeout: 3000, - 'from_currency': 'USD', - 'conv_currency': 'RUB', - }) - .then((res) => { - console.log(res['data']); - }) - .catch((err) => { - console.error(err); - }); - ``` - -### Query params -| Parameter | Description | -|-------------------|-------------------------------------------------------------------------| -| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | - -### URL params -| Parameter | Description | -|---------------|-------------------------------------------------------------------------| -| `period` | Available parameters: `week`, `month`, `quarter`, `year` | - -`*` - Required arguments - -### Response -!!! info "Output" - ```json - { - "status": 201, - "message": "http://kekkai-api.redume.su/static/charts/RUB_USD_20241108_DQVDN7.png" - } - ``` - - -## Creating a schedule for specific days - -### Request -=== "Shell" - === "Curl" - ```bash - curl --request GET \ - --url https://kekkai-api.redume.su/api/getChart/? - from_currency=RUB& - conv_currency=USD& - start_date=2024-10-31& - end_date=2024-11-08 - ``` -=== "Python" - === "Request" - ```python - import requests - - res = requests.get('https://kekkai-api.redume.su/api/getChart/', { - 'from_currency': 'USD', - 'conv_currency': 'RUB', - 'start_date': '2024-10-31', - 'end_date': '2024-11-08' - }, timeout=3) - - print(res.json()) - ``` - -=== "Node.JS" - === "Axios" - ```js - const axios = require('axios'); - - axios.get('https://kekkai-api.redume.su/api/getChart/', { - timeout: 3000, - 'from_currency': 'USD', - 'conv_currency': 'RUB', - 'start_date': '2024-10-31', - 'end_date': '2024-11-08' - }) - .then((res) => { - console.log(res['data']); - }) - .catch((err) => { - console.error(err); - }); - ``` - -### Query params -| Parameter | Description | -|------------------|------------------------------------------------------------------------| -| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | -| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | -| `end_date`* | Period end date in the format `YYYYY-DD-MM` | - -`*` - Required arguments - -### Response -!!! info "Output" - ```json - { - "status": 400, - "message": "http://kekkai-api.redume.su/static/charts/RUB_USD_20241108_1T2RI3.png" - } - ``` - -## What the name of the chart file consists of -Example: ``.../RUB_USD_20241108_DQVDN7.png`` - -- `RUB_USD` - Name of currencies. -- `20241108` - Schedule request date in `YYYMMDD` format. -- `DQVDN7` - Random file character identifier. - -All charts are in the charts folder, which is in the root directory (`./kekkai/chart`) \ No newline at end of file diff --git a/docs/endpoints/get-rate.md b/docs/endpoints/get-rate.md deleted file mode 100644 index 2cde3bc..0000000 --- a/docs/endpoints/get-rate.md +++ /dev/null @@ -1,164 +0,0 @@ -Currencies are identified by standard three-letter `ISO 4217` currency codes. - -## Getting the currency rate for a certain day. - -### Request -=== "Shell" - === "Curl" - ```bash - curl --request GET \ - --url https://kekkai-api.redume.su/api/getRate/?from_currency=RUB&conv_currency=USD&date=2024-10-16 - ``` - -=== "Python" - === "Requests" - ```py - import requests - - res = requests.get('https://kekkai-api.redume.su/api/getRate/', { - 'from_currency': 'RUB', - 'conv_currency': 'USD', - 'date': '2024-10-16', - }, timeout=3) - - print(res.json()) - ``` - - -=== "Node.JS" - === "Axios" - ```js - const axios = require('axios'); - - axios.get('https://kekkai-api.redume.su/api/getRate/', { - timeout: 3000, - 'from_currency': 'RUB', - 'conv_currency': 'USD', - 'date': '2024-10-16', - } - ) - .then((res) => { - console.log(JSON.stringify(res.json())); - }) - .catch((err) => { - console.error(err); - }); - ``` - -### Query Parameters -| Parameter | Description | -|-------------------|------------------------------------------------------------------------| -| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | -| `date`* | Currency rate date in the format `YYYYY-DD-MM` | -| `conv_amount` | Multiplier for number conversion (Optional) | - -`*` - Required arguments - -### Response -!!! info "Output" - ```json - [ - { - "from_currency": "RUB", - "conv_currency": "USD", - "rate": 0.01, - "date": "2024-10-17T00:00:00.000Z" - } - ] - ``` - -## Get currency exchange rate for a certain period -Getting the list of the array with currency rate for a certain period of time. - -### Request -=== "Shell" - === "Curl" - ```bash - curl --request GET \ - --url https://kekkai-api.redume.su/api/getRate/?from_currency=RUB&conv_currency=USD&start_date=2024-10-16&end_date=2024-10-20 - ``` - -=== "Python" - === "Requests" - ```py - import requests - - res = requests.get('https://kekkai-api.redume.su/api/getRate/', { - 'from_currency': 'RUB', - 'conv_currency': 'USD', - 'start_date': '2024-10-16', - 'end_date': '2024-10-20', - }, timeout=3) - - print(res.json()) - ``` - - -=== "Node.JS" - === "Axios" - ```js - const axios = require('axios'); - - axios.get('https://kekkai-api.redume.su/api/getRate/', { - timeout: 3000, - 'from_currency': 'RUB', - 'conv_currency': 'USD', - 'start_date': '2024-10-16', - 'end_date': '2024-10-20', - } - ) - .then((res) => { - console.log(res['data']); - }) - .catch((err) => { - console.error(err); - }); - ``` - -### Query params -| Parameter | Description | -|------------------|-------------------------------------------------------------------------| -| `from_currency`* | `ISO 4217` code of the currency from which the conversion takes place | -| `conv_currency`* | `ISO 4217` code of the currency to which the conversion is performed | -| `start_date`* | Start date of the period in the format `YYYYY-DD-MM` | -| `end_date`* | Period end date in the format `YYYYY-DD-MM` | - -`*` - Required arguments - -### Response -!!! info "Output" - ```json - [ - { - "from_currency": "RUB", - "conv_currency": "USD", - "rate": 0.01, - "date": "2024-10-17T00:00:00.000Z" - }, - { - "from_currency": "RUB", - "conv_currency": "USD", - "rate": 0.01, - "date": "2024-10-18T00:00:00.000Z" - }, - { - "from_currency": "RUB", - "conv_currency": "USD", - "rate": 0.01, - "date": "2024-10-19T00:00:00.000Z" - }, - { - "from_currency": "RUB", - "conv_currency": "USD", - "rate": 0.01, - "date": "2024-10-20T00:00:00.000Z" - }, - { - "from_currency": "RUB", - "conv_currency": "USD", - "rate": 0.01, - "date": "2024-10-21T00:00:00.000Z" - } - ] - ``` \ No newline at end of file diff --git a/docs/endpoints/list-endpoints.md b/docs/endpoints/list-endpoints.md deleted file mode 100644 index d1878a6..0000000 --- a/docs/endpoints/list-endpoints.md +++ /dev/null @@ -1,17 +0,0 @@ -## API Base URL -All requests to our API should be directed to the URL below: - -``` -https://kekkai-api.redume.su/api/ -``` - - -## API Endpoints -Kekkai has 3 API endpoints: `getRate`, `getChart` and `metadata`. -Below you will find a list of parameters that each endpoint requires and a description of what the API does. - -| Service | API Endpoint | Description | -|--------------|----------------------------------------------|---------------------------------------------------------------------------------------------| -| Get Rate | `https://kekkai-api.redume.su/api/getRate/` | Get currency exchange rate for a specific day or period | -| Create Chart | `https://kekkai-api.redume.su/api/getChart/` | Creating a chart with exchange rate | -| Metadata | `https://kekkai-api.redume.su/api/metadata/` | Shows the last and first dates of currency rate collection, as well as available currencies | \ No newline at end of file diff --git a/docs/endpoints/metadata.md b/docs/endpoints/metadata.md deleted file mode 100644 index e317d94..0000000 --- a/docs/endpoints/metadata.md +++ /dev/null @@ -1,60 +0,0 @@ -Currencies are identified by standard three-letter `ISO 4217` currency codes. - -## Get data on available dates and currencies. - -### Request -=== "Shell" - === "Curl" - ```bash - curl --request GET \ - --url https://kekkai-api.redume.su/api/metadata/ - ``` - -=== "Python" - === "Requests" - ```py - import requests - - res = requests.get('https://kekkai-api.redume.su/api/metadata/', timeout=3) - - print(res.json()) - ``` - -=== "Node.JS" - === "Axios" - ```js - const axios = require('axios'); - - axios.get('https://kekkai-api.redume.su/api/metadata/') - .then((res) => { - console.log(JSON.stringify(res.json())); - }) - .catch((err) => { - console.error(err); - }); - ``` - -### Response -!!! info "Output" - ```json - { - "first_date": "2024-11-26T21:00:00.000Z", - "last_date": "2025-01-01T21:00:00.000Z", - "currencies": { - "crypto": [ - "USDT", - "TON", - "BTC", - "ETH" - ], - "fiat": [ - "USD", - "RUB", - "EUR", - "UAH", - "TRY", - "KZT" - ] - } - } - ``` diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md deleted file mode 100644 index 26c4805..0000000 --- a/docs/getting-started/contributing.md +++ /dev/null @@ -1,69 +0,0 @@ -If you have any questions, you can write to the [mail](mailto:redddume@gmail.com) or [Telegram](https://t.me/Redddume) - -### Fork and clone your repository -1. Fork the repository ([click here to fork now](https://github.com/Redume/Kekkai/fork)) -2. Clone your forked code -```bash -git clone https://github.com//Kekkai.git -``` -3. Create new branch -```bash -git branch -``` -4. Switch to new branch -```bash -git checkout -``` -5. Push your commits -6. Submit a new Pull Request - -### Testing -Before sending a Pull Request, test the functionality. Everything should work both in Docker Compose and without it. - -It is recommended to use Debugger and Debug log for testing. The logging level is changed in `config.yaml` - -### Code Style -[`Pylint`][pylint], [`mypy`][mypy], [`eslint`][eslint] and [`prettier`][prettier] are used as code syntax checks - -#### Checking the Node.JS code - -To check the code, you must first download the necessary libraries, which are located at the root of the project -```bash -npm install -``` - -`eslint` and `prettier` is used to check and automatically correct the Node.JS code -```bash -npx eslint . -``` -Or add the `--fix` flag to automatically fix the code - -#### Checking the Python code -To check code, you need to install libraries `mypy` and `pylint` - -```bash -python3 -m pip install -U mypy -``` - -and install `pylint` -```bash -pip install pylint -``` -Start check the code - -for `pylint`: -```bash -pylint /chart/ -``` - -and for `mypy`: -```bash -mypy /chart/ -``` - - - -[pylint]: https://github.com/pylint-dev/pylint -[mypy]: https://github.com/python/mypy -[eslint]: https://github.com/eslint/eslint -[prettier]: https://github.com/prettier/prettier \ No newline at end of file diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md deleted file mode 100644 index d0bd247..0000000 --- a/docs/getting-started/docker.md +++ /dev/null @@ -1,79 +0,0 @@ -Docker Compose is the recommended method to run Kekkai in production. -Below are the steps to deploy Kekkai with Docker Compose. - -Kekkai requires Docker Compose version 2.x. - -### Steps 1 - Preparing files -```shell -git clone https://github.com/Redume/Kekkai.git -``` - -```shell -cd Kekkai -``` - - -### Steps 2 - Change config files -??? note "Nginx Configuration" - In `nginx.conf`, you need to specify your domain or ipv4 address - ``` - ... - listen 443 ssl; - server_name localhost; # Your domain - ... - ``` - - To set up SSL - ```bash - mkdir CertSLL - ``` - - After that, copy the SSL certificates to the `CertSSL` folder, if the names are different, - then change either the name of the certificates or in `nginx.conf` - - ``` - ssl_certificate /etc/nginx/ssl/fullchain.pem; - ssl_certificate_key /etc/nginx/ssl/privkey.pem; - ``` - -??? note "The main config is `config.sample.yaml` for Kekkai" - ```yaml - database: - user: 'DATABASE_USERNAME' - password: 'DATABASE_PASSWORD' - host: 'DATABASE_HOST' - name: 'DATABASE_NAME' - port: 5432 - ... - ``` - - Fill in the data in the `database` item, as well as in the `.env` config - - -??? note "`.env.sample` config for PostgreSQL" - ```.env - # Connection secret for postgres. You should change it to a random password - # Please use only the characters `A-Za-z0-9`, without special characters or spaces - - POSTGRES_PASSWORD=my_password - - # If you do not know what you are doing, then you should not edit the values below - ################################################################################### - POSTGRES_DB=kekkai - DB_HOST=postgres - POSTGRES_USER=postgres - ``` - - - Populate custom database information if necessary. - - Consider changing `DB_PASSWORD` to a custom value. - Postgres is not publically exposed, so this password is only used for - local authentication. - To avoid issues with Docker parsing this value, it is best to use only the characters `A-Za-z0-9`. - -!!! note - After editing, rename the config files by removing `.sample` in the name - - -### Steps 3 - Start the containers -```shell title='Start the containers using docker compose command' -docker compose -f "docker-compose.yaml" up -d --build -``` \ No newline at end of file diff --git a/docs/getting-started/manual.md b/docs/getting-started/manual.md deleted file mode 100644 index f921549..0000000 --- a/docs/getting-started/manual.md +++ /dev/null @@ -1,72 +0,0 @@ -For full use, you need to install `Node.JS v20`, `PostgreSQL v15`, `Python v13.3`, `Nginx` - -### Steps 1 - Preparing files - -```shell -git clone https://github.com/Redume/Kekkai.git -``` - -```shell -cd Kekkai -``` - -### Steps 2 - Change config files - -??? note "Nginx Configuration" - In `nginx.conf`, you need to specify your domain or ipv4 address - ```nginx - ... - listen 443 ssl; - server_name localhost; # Your domain - ... - ``` - -??? note "The main config is `config.sample.yaml` for Kekkai" - ```yaml - database: - user: 'DATABASE_USERNAME' - password: 'DATABASE_PASSWORD' - host: 'DATABASE_HOST' - name: 'DATABASE_NAME' - port: 5432 - ... - ``` - - Fill in the data in the `database` item, as well as in the `.env` config - -### Steps 3 - Install libs - -Install library. In `/shared/logger`, `/shared/config`, `/shared/database`, `/collect-currency`,` /server`, -the required node.JS libraries In each of the directories, you need to write this command - -```shell -npm install -``` - -and install python libs -```shell -pip install -r requirements.txt -``` - -Start the nginx service -```shell -sudo systemctl start nginx.service -``` - -### Steps 4 - Launch Services - -Launch each of the services -There are all three services `MainService`, `Collect-currency`, `Chart` - -- `MainService` is an API for getting the exchange rate -```shell -cd server & node . -``` -- `Collect-Currency` is a service for collecting and save the rate in a database -```shell -cd collect-currency/src/ && node . -``` -- `ChartService` is a service for creating currency rate charts -```shell -python3 main.py -``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index fcf4567..0000000 --- a/docs/index.md +++ /dev/null @@ -1,11 +0,0 @@ -## What is Kekkai? -Kekkai — The first free Open-Source Tool for Saving Historical Currency data - -It is a simple tool for collecting historical currency data from open sources, -with the ability to create currency exchange rate charts. - -## Why Kekkai? - -- Free & Open-Source -- The ability to create graphs -- Plausible support. Anonymous data collection with the ability to disable it. Available only to server owners diff --git a/docs/settings.json b/docs/settings.json deleted file mode 100644 index 4a08eef..0000000 --- a/docs/settings.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "yaml.schemas": { - "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" - }, - "yaml.customTags": [ - "!ENV scalar", - "!ENV sequence", - "!relative scalar", - "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", - "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", - "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format", - "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping" - ] - } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index f8a6146..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,62 +0,0 @@ -site_name: Kekkai -site_url: https://kekkai-docs.redume.su -site_author: Redume -site_description: The first free Open-Source Tool for Saving Historical Currency data - -repo_name: Redume/Kekkai -repo_url: https://github.com/Redume/Kekkai -edit_uri: '' - -copyright: Copyright © 2024 Redume - -nav: - - Getting started: - - Docker [Recommended]: getting-started/docker.md - - Manual: getting-started/manual.md - - Contributing: getting-started/contributing.md - - Endpoints: - - Endpoints list: endpoints/list-endpoints.md - - Get currency rate - /api/getRate: endpoints/get-rate.md - - Create Charts - /api/getChart: endpoints/create-chart.md - - Get Metadata - /api/metadata: endpoints/metadata.md - - Config: - - Configure config.yaml: config/config-yaml.md - - Configure .env: config/config-env.md - - Configure nginx.conf: config/conf-nginx.md - -theme: - logo: assets/logo.png - favicon: assets/logo.png - language: en - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to system preference - - features: - - content.code.copy - - content.tabs.link - -markdown_extensions: - - pymdownx.tabbed: - alternate_style: true - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.inlinehilite - - pymdownx.snippets - - pymdownx.superfences - - admonition - - pymdownx.details - - pymdownx.superfences - - tables \ No newline at end of file