From 4f5cfbe485870b6b4cf78dc7e4748d4e4173c5c4 Mon Sep 17 00:00:00 2001 From: Emmy Steven Date: Fri, 16 Aug 2024 15:47:24 +0100 Subject: [PATCH] update docs --- README.md | 63 +++++++++++++++++++++++++++++-- LICENSE.txt => docs/CHANGELOG.md | 0 docs/LICENSE | 0 docs/banner.webp | Bin 0 -> 10624 bytes 4 files changed, 60 insertions(+), 3 deletions(-) rename LICENSE.txt => docs/CHANGELOG.md (100%) create mode 100644 docs/LICENSE create mode 100644 docs/banner.webp diff --git a/README.md b/README.md index 8017668..69c5a14 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ -### MAILPASS +![Logo](https://github.com/codaholichq/mailpass/blob/main/docs/banner.webp) -Welcome to your new `MailPass` project and the Internet Computer development community. By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and include your code to speed up the development cycle. +
+ status + status + GitHub repo size + GitHub closed issues + GitHub stars + visitors + + 𝕏 + +
-To get started, you might want to explore the project directory structure and the default configuration file. Working with this project in your development environment will not affect any production deployment or identity tokens. +
+ +Welcome to `MailPass`, a web application that checks if an email address exists before sending any email. + +Read the [Changelog file](https://github.com/codaholichq/mailpass/blob/main/docs/CHANGELOG.md) to see the new changes. + +Clone this repository to get the latest unreleased version. To learn more before you start working with `MailPass`, see the following documentation available online: @@ -13,6 +29,27 @@ To learn more before you start working with `MailPass`, see the following docume - [ic-cdk-macros](https://docs.rs/ic-cdk-macros) - [Candid Introduction](https://internetcomputer.org/docs/current/developer-docs/backend/candid/) + +## Purpose of this Project +This project helps newsletter owners to: +- Prevent email from getting blacklisted +- Spot emails that don't exist +- Fish out trash emails + +## Technologies +- Rust 1.80.1 +- Axum 0.7.5 +- Tokio 1.39.2 +- Vue 3.3.4 +- Pinia 2.1.6 +- DFinity +- VSCode 1.92.1 + +## Features +- [x] Swagger +- [x] Concurrency +- [x] Message Queuing + If you want to start working on your project right away, you might want to try the following commands: ```bash @@ -59,3 +96,23 @@ If you are hosting frontend code somewhere without using DFX, you may need to ma - use your preferred method to replace `process.env.DFX_NETWORK` in the autogenerated declarations - Setting `canisters -> {asset_canister_id} -> declarations -> env_override to a string` in `dfx.json` will replace `process.env.DFX_NETWORK` with the string in the autogenerated declarations - Write your `createActor` constructor + +## Bugs? Suggestions? +Having any issues or trouble getting started? [Get in touch with me](https://www.codaholic.com/contact) or [Raise a Bug or Feature Request](https://github.com/codaholichq/configa/issues/new/choose). Always happy to help. + +## Give a Star ⭐ +If you find this project helpful, do give it a star. Thanks!
+If you are feeling really generous, send me ETH: 0x9F4942911f2406E5897669Db99184d47B3078E99 + +## Share it! +There are many improvements and fixes along the way from the day I started out. Thanks to the community for the support and suggestions. +Please share this Repository within your developer community, if you think this would make a difference! Thanks. + +## About the Author +### Emmy Steven +- Blogs [codaholic.com](https://www.codaholic.com) +- Linkedin - [Emmy Steven](https://www.linkedin.com/in/emmysteven/) +- 𝕏 - [Emmy Steven](https://x.com/emmystevenx) + +## Licensing +This project is licensed with the [MIT License](https://github.com/codaholichq/mailpass/blob/main/docs/LICENSE). diff --git a/LICENSE.txt b/docs/CHANGELOG.md similarity index 100% rename from LICENSE.txt rename to docs/CHANGELOG.md diff --git a/docs/LICENSE b/docs/LICENSE new file mode 100644 index 0000000..e69de29 diff --git a/docs/banner.webp b/docs/banner.webp new file mode 100644 index 0000000000000000000000000000000000000000..bf6a9d0d5882613838929178b75e3819e79e212b GIT binary patch literal 10624 zcmb_?RaBg7(`DoC?(XjH9$bRE1b26Wy9IYhaEAcF2~Kbc?oM!bdXk(Z-#O>|XD()@ z*Xmx+TUAfVu3goA(JC^Mk{&bwfQE#qlDZPNCM*B|0RR4e0S8oq0KQ9zJ;(uocqou; z5LzI36^LMhXpUUrdoohu2`xYkDvYJw6Hh$k9TbX68~PFdQz^9Ub20YSBfnsi8?ph2 zxru?Y|7w%}eZZyUrRUnvYSEzn1=pSbkbUqfgkSX|)bU!ipeFw%>0#sx*RATU&`PI+ zAOlcwbq&BY*jeqL_0)f*I-hRa4rncZc-{snE^^)7X*gBY;qXxR<&o z>d*JTuLkB=40v^xNrLl6f86=1hR|%*c-V@HU<<_=^V;r3N~uZKnpNJSUp4Qny#fR* z=S7Ft8Es^@^GB3a)Jo^9oOY zMTq!W($8Suk7T#E+vyYMKjWjE^X#T|A-IbH(y z-fzwx#aZJkY3OCTU`^as0Q}FxY&Xo$ckv$-t1EbcnzFlc7k|-4I zU(|?Tp*RN-i0McD6$^A5Ha+-Mj{biz{7EMylnhf+UD;o-Kr#j8Y$}7cS5Eyw^k-~8 zS5BC``7(;L?)rSPkb%N^Ahia`DfNg_*4@A`d2p1}+uka}GOd#Es49)8b2^r*&1N%> zJE^ym!FN5OxM9CI+{e=ltgvufo!cvI1P_S+og%oOAj^VZC`E%&C>-?DJABnynCAoB z_Yj;3%y2m2F#D^@!~T5WNe~0-FkPH!uT+wwxXCiz zwy}vk!&y>(v0u#Ff`)Z+Ug66#p_0e%j(=wwFVYy?6YXv#!K1KP9;DsJHGC~TN5~GV zUCfX-rv%z~H{y1l-FU%Hqb{prwBh(-&g(%bstcfui%aQ`k&hzRcn~7iqE25v5l-n< zbNYa*9*$coi^e5?%rt2wS^QnA*jjlh_}~wI{+?WqvIxP&vAvqg_nDlp!kNwj#UB5lGM@SUWXggn|Ut?C_Z^uQ9?q-tliTNje%sR%e{H)$rp;y2@ z`t6=lwsEg|XaGLBzBG7$V@p_Llki=tAX~8U!h=( zftl&Pds?w7_}(<45GQ7jX+b`AeSfq5TJk3h$(0eCstR=04HIL^-KS4+nXitZ(L{jz zf2NQe#5fpCKT+|zL`%6jJ$`xy5ikjvcdlKWUIq4jM$ry~u}9 z@8oKkkdk>q=}OucPn#A7c?|=Fb}>!%y;TM&gM{MzvJnpMLp=upV5i`?|Czb(^xq*x z!eN{E+d3mk%|ybqzStB>Y8m}DI!cHTJoQfwL%q_n<@wL%9-S)5<8S!>!{X&7+WT#4 z#z_b}of-f@G8Zy0BIp5)|0O`y4xxkl?hOHeoSuw{1*HcGDbThQ;l3jf2qJi7!M#Nm)tMIH+3+hNmQZ@?2%W|L z_pP>P)M7Mnj2xB=x8v}H)y6RJ15N;dBZWG7urtzRiMP@T(1`q`mssWcL;Kf+qfyjt ziZZJUV*EFe>&}~S$ZKz>=|b9OPOR-uFo4H}5Z0v6W{vEy51(5v%>%olJ|=`qJ`Hf> zl&LNEVAE!pGSPVHGj{YDPk2KfLm;B4LQyu?>7g8&hxY8e!dD~0_}H*7t|IEJ00o6V z>Xk`EAL^%We}k(|Iwn}P!95yS|hbA%G zp^xD4nqy-~_3YD$`*bH-A_8~sK3Q*7DF@I!pb+J#?S%mmCt&y+c3bTBPPI;`GCCjP zfT@7L|7rxwj{kvFZ96<>1=dPz(?OPe*bn zgm!rKi&b9LxKuuH$IgtuTXmu0FKth1gK;tcAOHfUla^8x<5KgcB;yU&{?`*6IgT_^ z;yd40EqpsO&CTp{^)>Sc{RhvP{jPLdV1?1DN#X0AFR%EnGM`|_LHlpG*w%0hNkg|9 zQ)lyhmsmrl3x(?j0}^9DC!t)iVU0AlLZ@m9-+X3}acA{CCBzo^paNA@}Xo>*Hj3*^mb8x>}y&4PpF`1C%ARpbRxJ~KL+d2%EiHCa?>XpHYwwHcr#mAr*3MFga=gI-8jXkQ!d(8g1&OIAe+4a&v5ds8gXY*-o z@XI05dU*Y?V*U$<{=Se%(R*jClJS-3X22<-lhS)`yO#{_HVOm^##CaNd5AjA(x@Fj zJQO7CiVu>;#&Ydef8FQp!JB=r?)WDsx=m#huV(nHa5mvV7B zaRwNidlaBBisLF|O_fq&hPl_@qMbUWd-gV-@ti{I%~#S>sr8a~I>&V-Jk{{M4CK1; zJRDv&*2K7!B2aN{=tjPtSk)s5w{lw81tIkZ^x&$Yov8+ijik`3#*qp`XDItjeoQ`M zkr(0%U~f|n@D0Lbv+x*wD%OIORT4A>VNL3#us(jNXD}Lze{En}+K+Z$AFId%s8!an zcqiLX=a%4CN)P2JdFM*KX{sG;2p(TcQ1+zU-LCjSv@lZiXy^Q1r6?DwO2PiK^)Vxt zmUv8{Q|%>21{)nC;*N6cK?2h{#%!BG9=4#w*g15^60{(TR7mI@3NJWD%c&mb(*$rb zm6eD;(DnkG9uH>mCOcLI06;_`y9+Ujo`7{2#U0ab#vT@I z9AG&e4OrBX=b@S!KoM$SptTf#1OV)M`=GMrqDb%C0DO0D`Gw*By$~RjEg#8?G1{p_ zAWDWna=-Cxji_;?W}`Vl*Rkk76nXpdiWmCrA4z*X)s|!WQXDe#tlQK|X8mT8zP~fzp+fm$WlxQ-^uQKsjv^uIF<`%?$btBfqsTKUmam1JMGJuo$mmwGOK z-BS(owz>^LL1<8Wp3dNfN3qBNmKZs+F^j9J6zf(SlA!5U#9RUfzTM?Q!<68ba5ixs zmFuH) zt2DH^i~-*D?1+U)rz@J!xDUDzaO_K(W9MTd26sDxsg+_7X$Vc!Rx0!pP*O1Qqdgjc z5H#&v#Cb%sNmRA~4XspUTklxm!9Mgh!Nnt&5!mqMt zrbjm=X+DqcqY=VFCgpZz%MRJ#ftnS_14i|v0=Lm{z(2$;2E$i`6+&JYR4$>Ek%*O; zcE~)9Bf<}C;O$^0$ESXID}x0Pv0sNrEh56*9L*rQT*syAzcIlfCLf7+I(Y@UraHja ztAjr4Co{!nOUAhvG=+kjq^uy-!4ldGKVz+amIp#Wh`p4A`fY5(RH+W>aykKOIX>}i zEiUeQybzKXwEipCutw-;4iX0_vz}U!L$!4fn7KYo#rpLAAc|8hv27u79?cG0Ca--0 zRB3(0Rz%9J{;#w%TQP^#b8fZmPJ8bZuf=D5P1PZ8teR!1xwez_Tg5LaZDzB1SZ8E8 z!G;GfCaI2R=KzU>6I$QwN0t1@s4o=jaCzy~a-6hJ%V$81=eS?v zEtNH?Zpdo4KZ!%`l9YsErs;j!&6QqYw_o#H6}nuvBE%9iod8=#m7QR3;C$yKZ!Bfa z5V||I;hLa#QGSC=p)y1VnL}}Q!eBERHhaTn3_Y+y6Li^;s-6$?coNj4{y!^WIhFG8+ZnO<$nN(wQ2X9?-o369NSDS(}y zt6i3*L#X~W>?@(NX*3f3=N0{BN~8!K1U;=JJuAwf;zY_+{3B7ETP%}@if#g$ZbUm7Oq@&^F74VvP&hO(U{+!Td zr(|qwLf1&Hk1BB#Y7iQj%XrEZ>XwV~35%0XV+hUsqvv8Uj$JVE>9oV{DWIo$Q{lby zl%0tj&TJkw^OuBibrmbV81cjcy-=`?<1ulNB}%_m;0`N}1Mbd)%+(h?FsP8v)veT- zwfMqY`dsW)#-~ZZC*t#qdsqI?k+m^!FX@V-_9&;%)f226^b?ygqW(v3yzT2h!o)b8 zt`7yBX3+;gkDrem*@|(8Jo1GOg((29(Z?G{6*7aEBa`4YJ4~?#?^cJcDV@SX`dzoH zR0tmR^Ns5i2rx(tWyWtSE;~&z`Ef}M0D0sel<-Bq8gQaxJbo3L7dwWd`+$f`6S)jt ze|Rb85#Nlaj!5sy!1=mo7m5GPSJlB#C9F( zDc2{Aq+m+;*oaVVPg*s}{RjZB0gQM!($*XI9InlNixX`5OSUwpT8(s+R+T-c^HmlV zVD9OCaxax3F`muOkS3RMw0lqw0ic<5H`y!SE()WTfhvUvq(+MEXjenlu)5QGZYIRs zE_y1LWr_xWiI-3Izj}m+%%D$1lJoHKuCo_ORM1w#bLdu?&c9F!fh|x{B@#l}S&A?( zW?-~CH@6ruX*;R9SXADmt6iT`;kB{6T`5?D0mfPvrf!wT6|d@(>dv)yad`li4N7Xv zawLRLUh^viw@Ey?wh2=zmp=QdRfel2$rFxUF`O83mwQYd6!wmw^9(VzIFjp+@vpQH z`AnzcFXMzj>)R@2eds%m9dc7LRE%=uI9stKb}gmKi@E_;N}`Sp*}TT#^;MhcAODv2GavNw4vmE3wVY;Yu1tUK!7(<+O~&l^z1Y=#5b@tC=@dV5*&* zY~YNzyhPPnhTuMkV?W4jAg?m;RbWTZ@6Xcs?c>F=Dz#xr`yg*MERU%s@{_#Ywj z!{B0y$~O)A90EsyClX=LdGQBfEqjM8tg;O_d}Te^3^*?+J1`ya5Oz4hp`e&U^~BUf z5|*N*pcDM-7bn%Kgo_VGTaK^&J6py%34|V*Y~GN46`$=SO-`*ZM{W5Cf;~iyjW0+2 zg%3ST0|No?DM9W7-h47)`l? nc;<=%k*{$MQK6YhBhlYP(J^lcF}Qi@ZY++R?MDqoUBKB4HNF!bH4yF5?^|Q-$;?HqN8?aPH$cNF? zl;2d+8%uOLlXu~!0cs^pu9C&>)mu=#ler-d5e-!vgX3(qiS(9`t-^_onpb00tp^?g z=j!WKQlKVZ7v*nm`x}v^5xa@>r`-#Ui2^>opfiGK^h(r>3F<0tamS9uZ+^+24cy^o z4fI7UzEaSCc8uFxN1bdsZ(OB(_6MUxzZREAd5=#1b~&7op2mLrvdTTz6~9p5#;9|$ zKPUiDjj}m;MK4r9+H1yuZ?G*#!2lGbsRb83WhkRGl&Ls{2uf>w>dh*bxBsHfV#}tkZVGDDyV!r0dmH96ymH}G)?7(3csT#ADL zbwgqP-ChBh^)rfi$^Z~Q+Y?!ydhV)i%#K6p^8E40)$6&@Bv8EQtt$PwNG8;7Q zPb{E)fth+&SI%#dKQK+r`WYyW;kePuqrcm>%U-`WhNzja-4dp zsVX;wsq4_FzF^%sFm99M50Dt(e&~XJ%NFlQf^qkGTOxeG)YySGfH$)lEWiWY9_E^G zlGu35UZ#Lufl|C-SVIF{K$5IuX+38;XuaTk&4ND{aYLQnXTH?Vb+870#-@=kj+)FK zZfL)=;7O!a(W_dT5wiyEm9%m;^g&}yE1MuG%galRM!gFesSds)Iv%@qB&Y7}4egh` zl*{+oDGQD!g0R$gxlaDaW8Cf(+nV{AIEF zcJtCRk3s=EXW-o!5kv2K3?H5pBv?tV@78Wz9=>jHA6 z1!*IO@#%U!& zArY15E_RoSxtJv27k42bW;w8!1uG+}u2T?D!Fb=7Nc&Fhe2ZnDK_NuNagZxF=Qb$d zCcU@Bw~B>n44DH>cla8Wh;V~`6f>7W=jB4ETv`u`N zt&Gzk?;rdeHs_!tkB4=V=LX{B)sRtO4+SNC4aA8*U|j7um&hxng-mRY;cInF%V(GHb;=ddpVX#N$denj&S=w&I%=Ao~jbf332xh#k zmN~wpF8q?Qi)R1;F{BL8jBBJfnS`q$TRku*```-CPY8OINRPgr6zgiDKFn$2DY|rp zF)UcoGS8yT>yf>LZp6+ifk}UuFPn;>@fZ*^cX-MXrv~7EMolQg(0Q$>c;2lh((_m< z8U^X=btNLeZ|BUKml*43QQiW9@2_-WGUvfVtkN3CbXzx#R3Npqd1WCtpH2*ng;xHi zo7t&qoO9rzHW22-+L1k4bL|72Zw^10Dwbf!087D|*4c7x3g z{8nq}_NRC7WN8XqQu}JqZ29wV?w`Z5Y|mt$WQTJG2pX34MixDeTXus2ni#PO9oSRpNnt5~95V zor3K+*P*YM%igviW+uDrQGs(L;5{v(d7g`?TIObt18n`T<%FNY1X(&Z2Y3vX6~_v*7==G;OYCb$3&6rN>c zt5=Y$wj+y%I(vhAT*z1hzN^~_=(P~}Qs4oum@p9+J_j`SK zXKp!0@oBuIkteO(H<;mzOOpp&5K@J4ntGu5<7f?+gehG2j@C>@3o^nGT{p~+^Nqp& z;=^yXsMGf1-O%IOEu;q>d;J^)R+Y|YH~H6|@s*iz<&I2(yRo{{$x}!y!=admreNDh ziZqFcXuW-0a%MX}psjB-3VJ`~7VRGoYkwL<%}I-gZ<1A~Q?svH_B?#6bYpkT8};zu zi@ptusR?m8(G{fEp)%|Rn@AYBzFo(%748|K82R$L0O1Uh5%+baUAX`kWW*M7@SPqsRb*sL9;a_|pb2<{spQ=dHdW-t z+>^AGMV=D(T7|%1j1vQJoO?QG_bQ=MQyjXac^f`b8Nzl(9z1Uhk@z&aGK%fR_r>d37h* zui3w_iA0SGIJ!af#KE)=-=J#WBxzoJGNlJzBO8xOqeH_7bfCh0`j9)mAuHZW-rp-o z+>n#)Eg!i)9yhk*clgLSz8G7+GK|mp!qS^gS}fisBu1IT>+qVh>CNYZok!fS7U1YB zM4s+i{YHqa>$%6zuh|!vIJzY^ai+vW5T$MWHX2h#xesS*BVU%vCB%w zw*xyR+qLeBKHXG`IQAvnVK|i79Tx}Ea1(s9h?uJuN5{9?sGJ9#oUbI=cMDbkmgaCD^3jEYEfYVC zgK|IHfcTiweP#w)8rh3^0HE&C9pF9uN3#T$j64PcNMYR#A;tSb2S~hzM{q9H5kFt~ zQ4*{J0Gjej#0%g5j>PZ5>tX9)Yvy7^>|twT=gjLNKxJfVZ*0c<{rp4BL?sAI{OiT< zWcr3zMO^Zi>GvlADhn4E2VN#7cXxM2cQ!_QCvzqi9v&VhW>zLvR)+5u49=c*E=C>< zcFttqJ^j;_xS6wwlcj@;rM(^T57$P<_O31hR8)Vg{z}Qzl0#qIhre<%9Ty0#a1XawO zU5s3vjO<*98HhRfnSSJEWBIqsKPCV4$Mio${b}~MBL6Sz7jbcMvNZmKft@p>(NBr% z58xP0>}{EhOn;!j{0|iVy2UGE>ioCFe^jDs=J+qkcN~5w9E_Zt&D1;{%mk>uBVh09 zWMcOB=Kpdi=458%VrDAH%FN2nz|76S!pYC{FV&y^@&8gtc(}-z3i259aG0?3a4?v? z;bLQ8H!|a7Fy?0E`Tk+VVamyF#>Hdw=8vzxuKbrLN#pO1I9NGYIXQS(*jc!EIJlYr z-1({euPbWyt|k^g$`WM#WBDK1f6V_kZT=@*zf1imtpA@H?eMpO`qAYdbNI8r-xc5c z%l41{ewXozxVl)_I|)kI+IkYJx|q3{+3_>|P5!Ui{@