From 3b9ce761920da458f4ae6cb92345d921efe4cbd9 Mon Sep 17 00:00:00 2001 From: Alexey Poltorak Date: Thu, 22 Aug 2024 23:29:15 +0500 Subject: [PATCH] Created README.md for NuGet and README fixes (#2) * Update README.md * Updated project properties --------- Co-authored-by: Kirill Kovalev --- Abblix.Templates.csproj | 6 ++- Abblix.png | Bin 0 -> 11657 bytes Nuget/README.md | 86 +++++++++++++++++++++++++++++++ OpenIDProviderTemplate/README.md | 23 ++++++--- README.md | 21 ++++---- ReactTemplate/README.md | 21 ++++---- 6 files changed, 128 insertions(+), 29 deletions(-) create mode 100644 Abblix.png create mode 100644 Nuget/README.md diff --git a/Abblix.Templates.csproj b/Abblix.Templates.csproj index 152773d..a6a2fc1 100644 --- a/Abblix.Templates.csproj +++ b/Abblix.Templates.csproj @@ -9,7 +9,9 @@ ASP.NET Core WebAPI project templates developed by Abblix LLP. aspnetcore webapi react typescript vite frontend openidconnect oauth2 authentication security identityserver abblix https://github.com/Abblix/Templates + https://github.com/Abblix/Templates MIT + content\Abblix.png Template @@ -19,7 +21,7 @@ content $(NoWarn);NU5128 true - content\README.md + content\Nuget\README.md @@ -31,7 +33,7 @@ - + diff --git a/Abblix.png b/Abblix.png new file mode 100644 index 0000000000000000000000000000000000000000..1e023d16959cb3c289450783eff2220d575c1101 GIT binary patch literal 11657 zcmaKSbx<8ox9!2*-4E^@+}+*X?cnYjB)A0&?!hf2xH|-QcL)~T9bSIlz2Cj>kN3T< znwsvez1Cj4_nw}qu8CGvmO()zL<9f;C~~rr>VNOS|6K5}002Y-pPJF%0fC21+-L$~l@@gVn)imcFhdU_k%?iqck7*F#rHk>A4Ek;UvE8x|i&m%nHL zKv2ZT#mvGU>;W_fTiZGbQCzflQvhu(g(!5mlvtHqB)~SdvVLx04L@Z~3qN}cK1&J_ zVW6N7|6c+}u!kAY$I-#bo!>`@;$OV{fBXMTgD8OiGV!n%qWCXSx=N}*31>Gjkc)+z z*@BIe7s$iM!p6D@ zM?w@f9v&|IAdt7WH;Xq1i?f?Gh>ef$F9$n_ot^ow1+%-alZTlPvy(gJzZoRK?iOyg zE*`edPQZT{&CH!WJ%lL!D*dkz99{m0*2(?9m+9|#A6E?jm_vjk+^ck`{eu$MQ+CuvNn`^f+ zA4F)?k49L^F`fJC_|W@A6QgNg^`3s20@IqGCPU!27qsm8qvOE_@riKs?I-*25uLDE zjN+4Fa>$1qM_jM@df>~Sq6l5=@!K%!C#K?L2Gysi2YR%d3-Z-6P`v@**^D?2a>@#qJQ{9WFHLGAW~JbP8Nc4e(WzGf**wWW#j#r zaf&(WtQL{w%-UOxg$r#JrU~|Qa;|I2S$R**Y{r-Pc>8?#osesvNlzWZ49?E>h(~f2 zI|T+GK$T`iEdq(Nr6hg5w4r+q_ocMGmO@8=P)&jrS9ZFbhm^L*MjUmmisy_rMNN`N zY>}oy5eZLcb4$1I&xfps%W zgLBSfd+m0GNNyeg;}bA#5VR^^ynK8d2g<6aC-!TQ<_Pz|FCasdD#vY8IhaoT+Qu09 z1yGDb2IUvPvUUhQzQA#?IvKs9f#5_}1^dX;MA}e1#!cpRxBXr)IY>f~mz$uqNm+x9 z0B#uYJvJ`*tZZxn;GQJZUOj@0i(c4QG2ZJZN?AKV`}VAymFiFrfmVS7G6R|@3?dRE z1zArgfKk%&>${l^EVx>v8>qb5Oe(_<2&uBp>;;D;jF^}zTfz#gO&^FXmu`tdC7hXu zttBh~GRUWICxIpRWcX2W$QN6p>!Sl<1l%s50_*)RJ#p@Df>?$e+(0VW5j+=noP`gJ z+;_32`nrOBX_mZ?xB^xnY?Ry%3z}#|4%{s4a$iLDLl6rqrBW|Jl&UE_MOT2irO#Wa zDp-C_#!m?;&6i<#St1kmHQdgoKCp+Ei7O63IRX-as4q!=Y?28FQm8-ehG}Oa z$Yb5WmR`^m#zM5cV(nZLzhA$uLBf|5G5oM2qn;# zm*KCKuY4~d77#yND0zPPXvN)v;uEFb4My5nBf_P3g`uZl{}wMXzRG52`GT?8X&tYZ zB7a+dAFFBfnXulW10~od;GMKK2D1Of0AIbBWBQ{hF>Sggkj#)`z6b2! z>~Mk|v|C_|Ho4I#OgpYLoWT_qd#!7-Ek^`q2yh>Xq4#TDqgf}RpMb_=YYEOLNp7rb z#pcE(mtuhj!<jZUdY3Z^tFe1 z9nY&Nk$fp+g3a}|PySOwE2jRm$}}l;=yxmkCXIVRkgC>>AT>#|R{@T++S+WrlThv1 z&t4GWEVCN76wu;`vkK@iotCOWAz~_TFrAXOm|gQ4a_I0+njzqsK?;!O0gCIOBaXpD z?u};`M|$p>v6W&mWqmux7s%VHKsV@uyMl7}LsK^3ph4~D-?FyMpTGAl@^y-bQxU|<{7oUar-N|HkgzpxP^K#{ZL;ni@&s472&RN zrn;{H#PmczM(Vj?TzWinqq{X!rgs%3%DALeTyVQYV za*ib@vjAGVXfMxTS!Z~j4%3;c0f@{=czDEsyqx9Onqp2kr@FCXOR@12d=^}MGzHb_tWCq@3vbUB z@5c%9pC@j@OHOk2c|LtW0@w%j70<(mS1urcsHAnm_T;Lp{b;|G zF2>LkqcJWjDx@BFA%Ie4KV;$)3O-Y{c8WQKW@cU5uZcD~VRZjOte(4)wIMLgS>-2NSPwvCY`$) z|4HH*wT8Te)i%?_ubft5F%A+PzViBa4&)8TxULgMmcgBM$Bx_ERyVtD1`4_CQQy6_ zL?$ql&(AQ0aWfA((nl!eJSyxU-?N`28gJDkqi{0N){r8g*8nYem3LE#`6sD&j7)@< zo@%ijCJJ#8TdG+2=VSss6UGgUObNqp6Ho57addarvDQ#2=L-j9Niz+J2H~=9Mxuz~x?pAj!lhQu8a{G@5pN8&a{2 zKY~jU27oL&C>9JauC6nC+EHX~ErnBCg?MXEcv5DSCUx==EA+t#c+q|!l))LC>U>FZ z5YD1mp|Qo%cZha$u&}KXyOQdqcvKxA4DW)E5y$DJ{eTh6e<`qmF@dhqs)CnlC>Cxp zH&~;iwguYXfM+u-m9j1C&&Ka^1l+C9Po1o+c-kw}L55yGGjlWD&sz^)CoghZPtaVN z;UfJ5uunq*@`~||lf#&;?`fCO2dOW9(|*E>{eed#GbqrnWBM|hJdqx@PK-#pu-Lnz zG~q%VlwEo<>j|Gf;=lSp(IEa#IQ3OE3+}gPOg8;6!sB)KW1#LJByQJq#L z!AgfK)f_xD+7UC#(yzfQLo&F{m#x1oxo5>VR?`BL%G*Z4hTrXx*Zb3o_fsZUFMpBi zVkIT7ZKqLo=MztlinWq&psijGBFQDc5AU)a9rF=cgs1{OrCq`K2R*l{#HS9uU z5@|N-mG@hlB;6ki>`2%o za#@Spn?yPrrLN_E$W=inS>n5}OO)7@*ob)F)D{vRV4K#e5UV(<)@V9rGz)Fd8Bub2 z&cLxrBTu34!!1u?XRJh3x!bufe@RMhBz))w;Y>hCv+CP~TyWW!A4LSSnuG^5GG@^s z$_p*^^Q@12leV)5rZM0B7e+ilsPK;m7FZhIu^Njn9@k&KYKIMNSGt!|U$_Ka4T>t1 zE1-?lsL={sHR#1aMzQ*9C)4PiM0_PCh{H9><)mJTnVgqk9Nlf-6;PtHanc+uV19YT zU@XF}k3eV$TW2_JB7`(j7K(!`_nsy{wJP;F!Z-c{JoGxC#QLO=>9rK1aK3+2vuR5o zl{y^YGIolMykn+8N5;xEwDSey6L#-_g*`fg7LjC0JaStfW2hQ}v)zksQlj`vH#Mdm+d7oiDnW(3+GtnOZf}oT;nBT6)fnA1*)qW z4u0{E5B1TH{^1D6#jICY35dM~? z=wFq?^Rb*B1b)CLJ7xkmx6uA{xX zz_lV6--<#HLaA}=bB&NpeYhvk4k2zHUyfRk#A_g<2RlkrH8)Sy6k$wW_77!X^o2uI zi7=>J!AeXi)i8C%P47IUwK;>Axw>0qXk<~08WDD)k^MN*caiX?kP64|mo*oscNrPY zal#&gx_jg+*I?r<+f7Znb-SBj=I3LQs3!v?NF7lYa*HSJ*BF4U3t{-)LcBaoMUn_L z;$J;az50{H53TXz$_T*Tc{sJjmr4`6PmM1!XEQTWFB`Ika#GrTr)<>or<`2OGLQs$ ztnUR3>tvBkG!|u&_{!*wsT&_ruH)6F(V>peskdsM?Av9JUVTkjg5@7AKfVnyUXszq z%RO2~CW3jw86>Pf+dz<=2L3wwvuQ2bC~u`D{Z-n(Y=KLzOL9W}DR{&OrEW7a9_+VQ zwF)yH!`8sOyU$EQL73W|y6g65kBj2oG(U+lelx?I-91k7-6&Lp{%3_0aXBu%yhmsN z4#dM(SucF$a{ciF@mhCXy(W!GL|&l$qgP9y><)?LwnoP7F4`kRnQ1umb&AAbYcY6%NNV?p|)eHJroO3 z>qK*eyEk9=^tsF(+kB=&to-#o?u#2j*;`ZU>9`a6g}L-IZYNOeqP?1jzKZko*YEjRU`raNH z#BzJvGF>fW!1?(z+OUE{&k#2R9DHIMRgGLq#B5}#I@N3%r(H3F7AXZ+Wf)qVUR zVk44Hn||GJ{X>rb`vu?O=C|PXT*!0sZ6}#vC6u%=RJOaO#$uI^AbPE;4Dw`jDT(q@ z>Eq{f1IpXeBcM4P_<*X4ZzCQYZ*fT;0a|pxG`z*>nIGi*n;&_#Mv@eMx(Z(iDmR=miOVb;&Pb|i z$_mr8pAkQ-T$Ct+y^n|Iux?l3tmBCD(Pv>0&{)A*hIOjuWY%=37v^5epKf3SN8u+O zHVWwWhxEmIgpDtUtyQil>UYfj0MA$7Y0AGTOwmv(7*DH5ELWv^JQWo`5%{}(t=t^f z=)VM_aB-@WX-KM+n6=AexKPxK%4~kb{+LE*xjgVH0tG2eVX61xFap%QU7F6Y8ywR~ zwY%48kG~0T3ID#Ea4OomT;SQ#d3XfbAT#@l}JT>I@Pzg zw!nOp4MJ*=bon}0?iP*V=WLetsXYsRIe2%*pkMRlSY`&ZMEE7l1#FWl5tfV-R~P9I zP4b@LLMc`bm8xS!bKECSF_o}-5?t{mzM}<(s>Fl@JxP3nfpbG&F9Uwd`#1H4@!y9H zPFMC5CJq8O^pPX5qf9%|$BXddqeUky`Fe5?4Nd#pCnRuMY~ti4-K`;8uZTz9l5Qui z_ep6R?z!W^!+fxe$EHJ5151%wN**}`8sufZv)q5`vYxB*n?x325VFH}>C!$2QwQ@j ztS;c>3t?t%vtS6VLPCLsEq7~AkH}NQ1Hr*93IC|Rn{M~!0L+7TDONwqtw62#^n+GG2^VH^t`=y_tx_RshhVy=f}6fS*# z7L{$GrVVszwLfH#R=mqeZ2icVP$pTP7kg6ecpVoS zvq?JmBSvAWU6qtZeRtUqnIssTHHemwW&{P>z%(0$vX7UQ^@v{^%$S>~`sk2e`ag^& z_5v?Yj#FfF(!2;v$-TS7?8f6Kdhg-d=gT_T2aVuGQ$XWS1Xup)e%05(iark)vy=ww z5FKDO8q`q&FjLRk1mQPP=<%r^xdNceC$~gL;~F-vc!v$PV(aGsdb!otAYqfd3AfnW z&ysx5R4H@{Nkkn?)eF2r!G)YWO7EJYPTN;}9BS_y^%}SCAW7=eriRtGi$iv=ShNle z1D!x<{8#xdt7^DQ{N`bC$^5hmH7ZM1NKKLA9Nw&nqvWmgk(x;a%xS`~y}@vkbkaDC~S=YKb!pMX;}B zIze$xwwFTObHpD=&{uhm6Nut$6i$Ilbf>pNO0^{(NQ^pO(0z6#Tu;?Bb_v1?G;&sRZms$2mrJAYzAh>lx!ayD%o++g>= zp977#YTwTD#H(!?Osj_TucrZ7?Ww4oBGa_k;X~#TYxAZtRyoHPN7ugvE5roJP||nl za$&Ya{Ln{K?u}TqVn)pANh0iYINQtxBw#7FyEp@n)D`498(TT9LyaW9<1E85;=}>2 z6(Xti^9ci2PBrG_!&A2J7~jMj^=g6W_2^Lm?%>*&<7u?c#NdcWG@IKaJS15Yq_5Id z1T`5Cf)vNo9O~b3dE~cq=8EA}O}7LfJ8u~86krVxn)|m!PVnw}r$BiMvt3g-x9&c0 zs_mqUVU%M+^!s zL*Dl-jEQ%DlerR5@REjo?5YjXBQMd3+IisfYUQ}$$0-Cwt=tW!@f(Dz>8N~M{&aAJ zXLW9D4NB?Y7oa9JlTYTZl}ueCwPRn>lN5Jltc+cs9XRLI`w+ z9n%lRh1!QQ488tf&-fX%Gi=^vxYVd4&}RJS^JtRD%}15hj;9UuWxsPzi{3@+e7w?i z2IrHgq-gLt(XW11zr~yL`kORRgTeH-N#8nW~MS%^vQIaAUgtY(!Ed$_(eg4SyP1 zIs*o6G@(sjQ_nu9WH;M2e6ZzGFJ?sqb1bg1tc~Oa5fVYNPLn)1mZwY+)0MALhD0@r zVpPg^7zy{-x3}(QnEtwAnp&FQh+)D40%wp29@Mh5@?FoYu(z{$M&cdLP-NcnzB07r zUk(gvTPt$gY}Kk+rzZdmA$a-nRGn&5(}XD?yjijUdwrv6%!C`=db2%)mU?8N^e!|1&gZAfdd8$r_&2!3<`dybmWTs#t6LOq)tXV zc6$6nlNgG~?6HCFFc{)xW<2%re%_HB9g#!A z+Uj&_-S>tgvj`&%A*j+hv3n;sPnM>t%uc6&;uu_Dj8BFGy0liX&?l9LUmfmfFDs~E zjDSY!8*z}%agQG3q!?8osN0q(!XHj>f%ur=EcSq=Y zSXgqZutLGJHB4;n8Vn&>a7GDbAb#lxV&K7CE&7XZh!-83+>36{_v^;Z?FavH3a4J* z;ABj0)&qtk{WV+@FvQmF4BJW!(-T|SIXk8*x|LolZH}eIVOa1=kwJ^e2e1UBtz_x@Wr)0p=|TK#&Sjd;{~7Km>=t|^S@yZ$i1=uVGew^N>ms_L zBb1#Z3>W7yvg7#0pJ&(yj#`8X=_yl&M24>u!FjrRn0OPZ99)AxhR`=ATn9EXjFu&C z7nqAo7P+ST13(rftd6Onkn8Ya}vF6neqR^MCQqBc@OK=I?722gQ#D$+wiP2cz z@HfUU8mIJ-(T8|5H~vU5Z@uONeV}!MM|>YV<4LV2Ad$P}XXM5mt=d9PAgH#pCQfk@ zusYvBnV!g|_*bs0^S&9YmG%{mEAr0`QK~v@@HH{u&uHdkgYex|M$-aJuLIZ<`pFdx z4*p6y+rQsLpw_!T4h@x{S41xnc}}q#&KPzkFADp9Xny^OuyCATSyBRB9Wrw4$c5c? z-~f?TSR}e5WS~7ewz%6J;5HjI5#}AfFR}St@`Hr!=YD) z-dnnZ9gtw0l6Z*GFpl1o%NzKxZcd7Mv-ZQw=*;#j;4DFIdLZ?3oszrr%{g}`FVsvH z0vGf-{S&*=BfHD!uLH5f3BR3v$tv!HTIe*`kk#41Fj$&hVj_Il{5oSv7*TOL&{6rI zAPFpvZ1!7c(Qn>#Q?X0Hut0GU*XE7Cff~LvV*q42{iDaR_Qgz;=uR0kS|H)hlYke= z)EY|#c!l$x{&pwDvnb^r6>S>rYus6)F%?WpWWY)f>MRfF4*IL#=jo6yFikgy`P;`k zb@P^6?-f(u;Ad$cMVrYe0y52FdRiRU4;-XaEOuZ{zTC|~m8r~p(}<>$EbhjWfH>cK zcS#HMU^b08Hct7aD$!CphBK z>rWosA9i7!K3og-eSerlbbk;r+JnP`Ut9=MZWXT-|; zrvRS-q*F~o{_aF+C^TZSGLRy5vIG8{HlVAp>XF9zQhXC);YaftV(uZi4{)?raH;eu zj?YSfh*Pv$Re#mWt0{1KGE*CJr6X8T|L>8+300E$j`a1%nuFf; z>NNA!^ixnw)3wy3+#DfpfDYWWpo9LncvBgBJGp3uv5Q#B@C=L5Ru4oZr}? z6OXRObqPY}ojjbFsYWn|${!I8f!l}i5w`e)AS$}HQp*uWNv)ZXq6G0w3q#J+!ObL3 zN`!O!o{ceBJJUu%EM<}#z@=c<#Z;(_(k>8|ML7TLoz@vzfgPH?)nUXi7TG@4)*l@Hy-{nn>FTk{Ea16;HRmhogQH=d>xBu zam^M5m;FqEsxP!DS%GlYr zyCjPd=aqJ=`OT1;OXZ-8?6^5_t8Up?&%k--Ngd>Q@%~|$gghZ5^hw|9O|kzo>~{dF z$^c47o>EAzyDJp?uR$VLi%YdBv=ES9Z4EJ^b?O|WN0QX9OlW65L?o;91T?PBc>cId z3mvlfU)-dTuQb(gybE)SKPdA+N)4-DS*l1vPzKw;0As|%=%9F|asU{J5bC%; zU?H)xR+M>Va+o(d#uEk*+ZBAQ&$JKRO{plpY)b-*Ua#f%i0H_5S|J@s*eC|2 z*0pVG#i(S$r!#+ z*`%8gxEEy_Tr*8n-_TLdk~MzVm+Kb8DNFl7GY6h;yyd7NXCfbUR`>HhNg9Sq5GqP7 zLug?HQXRX>w`yt6aRhuHt}h9XWC#|MJB)p^qhRS8{9MwDhJEwd=Qm%+=4Tri} zSgOq^r6kmYo6Pt2Olnz4RQHIrDuANRWE;8EgV&w4n*U!DYF4fYXnUtO^-Veic8gS#-Y zyZTs;n&J(x8a~BtKBR-C=-Mv%aMu?{|caQdI2);X~flf${Fi)sM*^V=z3`Cn<16t(u# zl)neZq(~q~=L)cUo_bG;`Cq5y&0Ubdgtt0=H%@t?Ej?_t<*Axl;hO9f2?G$Ej_mP? z^-)>y*u#<(9Ozx{m3n$o&Mpqnr`-?XS{_9M$*O?4o_7DLIbZgI{Fkr2&0C4Y#5vlx zRD>6K;L-;-liblkJxX?qWyN@Jc)%^&8_n58d<*X89d(th)|nPnEa!AhucKfO45_-1 zqSyYrO?&OK@t<;N5y&@0(FvAY#t*?nlL7VkzYt9dse?VD4M1 z@ke3(NuJ0%;w4sD#mP>WA*sHpOrv_|>mV-BQKrb8c^HjIkJXd-H~C1-NR0Yd>V;WO zgxR4@QiQq|?)Kv@n{Z-qp%)eAt}3`uke!SCeraA#vYCo#JDTJ6b_XO*uH`>JN6SemOV)~;hW;N2GO$|! literal 0 HcmV?d00001 diff --git a/Nuget/README.md b/Nuget/README.md new file mode 100644 index 0000000..00de916 --- /dev/null +++ b/Nuget/README.md @@ -0,0 +1,86 @@ +[![Abblix Templates](https://resources.abblix.com/imgs/jpg/templates-github-banner.jpg)](https://github.com/Abblix/Templates) + +[![.NET](https://img.shields.io/badge/.NET-6.0%2C%207.0%2C%208.0-512BD4)](#) +[![language](https://img.shields.io/badge/language-C%23-239120)](https://learn.microsoft.com/ru-ru/dotnet/csharp/tour-of-csharp/overview) +[![OS](https://img.shields.io/badge/OS-linux%2C%20windows%2C%20macOS-0078D4)](#) +[![CPU](https://img.shields.io/badge/CPU-x86%2C%20x64%2C%20ARM%2C%20ARM64-FF8C00)](#) +[![GitHub release](https://img.shields.io/github/v/release/Abblix/Templates)](#) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) + +⭐ Star us on GitHub — it motivates us a lot! + +[![Share](https://img.shields.io/badge/share-000000?logo=x&logoColor=white)](https://x.com/intent/tweet?text=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Templates%20%23ASPNetCore%20%23Templates%20%23DotNet) +[![Share](https://img.shields.io/badge/share-1877F2?logo=facebook&logoColor=white)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/Abblix/Templates) +[![Share](https://img.shields.io/badge/share-0A66C2?logo=linkedin&logoColor=white)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/Abblix/Templates) +[![Share](https://img.shields.io/badge/share-FF4500?logo=reddit&logoColor=white)](https://www.reddit.com/submit?title=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Templates) +[![Share](https://img.shields.io/badge/share-0088CC?logo=telegram&logoColor=white)](https://t.me/share/url?url=https://github.com/Abblix/Templates&text=Check%20out%20this%20project%20on%20GitHub) + +## 🚀 About the Templates + +**Abblix ASP.NET Core Templates** includes two powerful templates designed to simplify and accelerate your development process. These templates provide a solid foundation for building modern web applications and identity providers with ASP.NET Core. + +- **[ASP.NET Core WebAPI with React and Vite Template](https://github.com/Abblix/Templates/blob/master/ReactTemplate/README.md)**: +This template serves as a starting point for creating an ASP.NET Core WebAPI project combined with a React frontend using TypeScript and Vite. It establishes a fundamental project structure and essential configurations, enabling developers to kickstart their applications swiftly. +- **[OpenID Connect Provider Template](https://github.com/Abblix/Templates/blob/master/OpenIDProviderTemplate/README.md)**: +This template is tailored for building an OpenID Connect Provider using ASP.NET Core in conjunction with the Abblix OIDC Server. It includes the core configurations and components needed to set up a functional identity provider, streamlining the process for developers to implement secure authentication solutions. + +## 📋 Prerequisites + +Before you begin using the Abblix ASP.NET Core Templates, ensure that your development environment is properly set up with the following tools: + +- **[.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)**: This SDK is essential for building and running ASP.NET Core applications. It includes the necessary compilers, libraries, and tools to develop, test, and deploy your applications. Make sure to download and install the latest version to fully leverage the capabilities of the templates. +- **[Node.js and npm](https://nodejs.org/)**: Node.js is required to manage the frontend dependencies for projects using React and Vite. npm (Node Package Manager) comes bundled with Node.js and is used to install and manage these dependencies. Having Node.js and npm installed ensures that you can seamlessly integrate and build the frontend parts of your application, especially when using modern JavaScript frameworks and tools like React and Vite. + +## 📝 Installing the Templates + +To start using the Abblix ASP.NET Core Templates, you can install them in your development environment either from NuGet or from a local `.nupkg` file. + +### From NuGet + +If you have access to NuGet.org, this method is preferable. Run: + +```bash +# Install the template package from NuGet +dotnet new install Abblix.Templates +``` + +This command downloads and installs the latest version of the templates directly from NuGet.org. + +### From a Local `.nupkg` File + +If you don't have access to NuGet.org, but you have a local `.nupkg` file, run: + +```bash +# Install the template from the local .nupkg file +# Replace "path/to/Abblix.Templates.x.x.x.nupkg" with the actual file path +# This allows you to install the template locally without accessing an online repository +dotnet new install path/to/Abblix.Templates.x.x.x.nupkg +``` + +This method allows you to install the template manually using the `.nupkg` file. + +## 📃 License + +This project is licensed under the MIT License. You can review the full license text at the following link: [MIT License](https://opensource.org/licenses/MIT). + +## 🙏 Acknowledgements + +We would like to acknowledge the following technologies that have been instrumental in the development of the Abblix ASP.NET Core Templates: + +- **[ASP.NET Core](https://docs.microsoft.com/aspnet/core)**: A powerful framework for building modern web applications, providing the backbone for our server-side implementations. +- **[React](https://reactjs.org/)**: A leading JavaScript library for creating dynamic user interfaces, which has been key to the frontend structure of our templates. +- **[TypeScript](https://www.typescriptlang.org/)**: A superset of JavaScript that adds static types, helping us write more reliable and maintainable code. +- **[Vite](https://vitejs.dev/)**: A fast and modern build tool that has significantly improved the development experience for our projects. + +## 🔗 Key Contacts & Resources + +For more details about our products, services, or any general information regarding the Abblix OIDC Server, feel free to reach out to us. We are here to provide support and answer any questions you may have. Below are the best ways to contact our team: + +- **[Email](mailto:support@abblix.com)**: Send us your inquiries or support requests via support@abblix.com. +- **[Website](https://www.abblix.com/abblix-oidc-server)**: Visit the official page for more information. +- **[GitHub Repository](https://github.com/Abblix/Oidc.Server)**: Explore the source code and contribute to the Abblix OIDC Server. +- **[Getting Started Guide](https://github.com/Abblix/Oidc.Server.GettingStarted)**: Follow our step-by-step guide to create an OpenID Connect provider using ASP.NET MVC. +- **[Abblix Documentation](https://docs.abblix.com/docs)**: Access detailed documentation for all our products and services. + +We look forward to assisting you and ensuring your experience with our products is successful and enjoyable! + diff --git a/OpenIDProviderTemplate/README.md b/OpenIDProviderTemplate/README.md index 1e5a151..01a3bb1 100644 --- a/OpenIDProviderTemplate/README.md +++ b/OpenIDProviderTemplate/README.md @@ -60,23 +60,32 @@ Before you begin using the Abblix ASP.NET Core Templates, ensure that your devel ## 📝 Installing the Templates -First, you need to install the template from NuGet, or you can use the local `.nupkg` file. +To start using the Abblix ASP.NET Core Templates, you can install them in your development environment either from NuGet or from a local `.nupkg` file. -### Installing from NuGet +### From NuGet -```shell +If you have access to NuGet.org, this method is preferable. Run: + +```bash # Install the template package from NuGet dotnet new install Abblix.Templates ``` -### Installing from Local `.nupkg` File +This command downloads and installs the latest version of the templates directly from NuGet.org. -```shell +### From a Local `.nupkg` File + +If you don't have access to NuGet.org, but you have a local `.nupkg` file, run: + +```bash # Install the template from the local .nupkg file -# Replace "path/to/Abblix.Templates.1.0.0.nupkg" with the actual file path -dotnet new install path/to/Abblix.Templates.1.0.0.nupkg +# Replace "path/to/Abblix.Templates.x.x.x.nupkg" with the actual file path +# This allows you to install the template locally without accessing an online repository +dotnet new install path/to/Abblix.Templates.x.x.x.nupkg ``` +This method allows you to install the template manually using the `.nupkg` file. + ## 🛠️ Creating a New Project You can create a new project using this template with any of the specified short names or aliases. diff --git a/README.md b/README.md index d15f988..5f131ce 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ [![Share](https://img.shields.io/badge/share-FF4500?logo=reddit&logoColor=white)](https://www.reddit.com/submit?title=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Templates) [![Share](https://img.shields.io/badge/share-0088CC?logo=telegram&logoColor=white)](https://t.me/share/url?url=https://github.com/Abblix/Templates&text=Check%20out%20this%20project%20on%20GitHub) - ## Table of Contents - [About the Templates](#-about-the-templates) - [Prerequisites](#-prerequisites) @@ -42,30 +41,32 @@ Before you begin using the Abblix ASP.NET Core Templates, ensure that your devel ## 📝 Installing the Templates -To start using the Abblix ASP.NET Core Templates, install them in your development environment either from NuGet or a local `.nupkg` file. +To start using the Abblix ASP.NET Core Templates, you can install them in your development environment either from NuGet or from a local `.nupkg` file. ### From NuGet -If the template is published on NuGet, run: +If you have access to NuGet.org, this method is preferable. Run: -```shell +```bash # Install the template package from NuGet dotnet new install Abblix.Templates ``` -This command downloads and installs the latest version of the templates directly from NuGet. +This command downloads and installs the latest version of the templates directly from NuGet.org. ### From a Local `.nupkg` File -If you have a local `.nupkg` file, run: +If you don't have access to NuGet.org, but you have a local `.nupkg` file, run: -```shell +```bash # Install the template from the local .nupkg file -# Replace "path/to/Abblix.Templates.1.0.0.nupkg" with the actual file path -# This lets you install and test the template locally before publishing it to NuGet -dotnet new install path/to/Abblix.Templates.1.0.0.nupkg +# Replace "path/to/Abblix.Templates.x.x.x.nupkg" with the actual file path +# This allows you to install the template locally without accessing an online repository +dotnet new install path/to/Abblix.Templates.x.x.x.nupkg ``` +This method allows you to install the template manually using the `.nupkg` file. + ## 📃 License This project is licensed under the MIT License. You can review the full license text at the following link: [MIT License](https://opensource.org/licenses/MIT). diff --git a/ReactTemplate/README.md b/ReactTemplate/README.md index 32fe044..57dae0b 100644 --- a/ReactTemplate/README.md +++ b/ReactTemplate/README.md @@ -15,7 +15,6 @@ [![Share](https://img.shields.io/badge/share-FF4500?logo=reddit&logoColor=white)](https://www.reddit.com/submit?title=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Templates) [![Share](https://img.shields.io/badge/share-0088CC?logo=telegram&logoColor=white)](https://t.me/share/url?url=https://github.com/Abblix/Templates&text=Check%20out%20this%20project%20on%20GitHub) - ## Table of Contents - [About the Template](#-about-the-template) - [Prerequisites](#-prerequisites) @@ -47,30 +46,32 @@ Before you begin using the Abblix ASP.NET Core Templates, ensure that your devel ## 📝 Installing the Templates -To start using the Abblix ASP.NET Core Templates, install them in your development environment either from NuGet or a local `.nupkg` file. +To start using the Abblix ASP.NET Core Templates, you can install them in your development environment either from NuGet or from a local `.nupkg` file. ### From NuGet -If the template is published on NuGet, run: +If you have access to NuGet.org, this method is preferable. Run: -```shell +```bash # Install the template package from NuGet dotnet new install Abblix.Templates ``` -This command downloads and installs the latest version of the templates directly from NuGet. +This command downloads and installs the latest version of the templates directly from NuGet.org. ### From a Local `.nupkg` File -If you have a local `.nupkg` file, run: +If you don't have access to NuGet.org, but you have a local `.nupkg` file, run: -```shell +```bash # Install the template from the local .nupkg file -# Replace "path/to/Abblix.Templates.1.0.0.nupkg" with the actual file path -# This lets you install and test the template locally before publishing it to NuGet -dotnet new install path/to/Abblix.Templates.1.0.0.nupkg +# Replace "path/to/Abblix.Templates.x.x.x.nupkg" with the actual file path +# This allows you to install the template locally without accessing an online repository +dotnet new install path/to/Abblix.Templates.x.x.x.nupkg ``` +This method allows you to install the template manually using the `.nupkg` file. + ## 🛠️ Creating a New Project You can create a new project using this template with any of the specified short names or aliases.