From 0a973f2219532fe4dba108b5bd52d4ec96531d17 Mon Sep 17 00:00:00 2001 From: Marc Farra Date: Fri, 31 May 2024 13:18:22 +0300 Subject: [PATCH] Add license, images and changes to README --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 14 ++++++++++---- docs/assets/board.png | Bin 0 -> 5128 bytes index.html => docs/index.html | 24 +++++++++++++++++++++++- main.js => docs/main.js | 0 5 files changed, 54 insertions(+), 5 deletions(-) create mode 100644 LICENSE.md create mode 100644 docs/assets/board.png rename index.html => docs/index.html (83%) rename main.js => docs/main.js (100%) diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..e0a5cc4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Marc Farra + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 23f9d23..4f686a7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# FIDE Players Viewer +# ![Chess Icon](./docs/assets/board.png) FIDE Players API & Viewer -View the list of FIDE players and their ratings. The source of the data is the [FIDE website](https://ratings.fide.com/download.phtml). -Originally created for use for [Keshmat Chess School](https://keshmat.org/). +View the list of FIDE players and their ratings. Originally created for use for [Keshmat Chess School](https://keshmat.org/). ## Architecture @@ -10,7 +9,7 @@ Originally created for use for [Keshmat Chess School](https://keshmat.org/). - `index.html` is a simple HTML page that uses the API to display the list of players - The Datasette API is available at [https://fide-players.fly.dev/players](https://fide-players.fly.dev/players) - The HTML page is available at [https://kamicut.cc/fide-players/](https://kamicut.cc/fide-players/) -- TODO: A Github Action to update the data daily +- A Github Action is used to update the data weekly and deploy the API and HTML page ## Run locally @@ -42,3 +41,10 @@ Open the HTML page in a browser: ```bash open index.html ``` + +## Attributions + +- Data from [FIDE](https://ratings.fide.com/download.phtml) +- Icons Chess icons created by Andrejs Kirma - Flaticon + +# License diff --git a/docs/assets/board.png b/docs/assets/board.png new file mode 100644 index 0000000000000000000000000000000000000000..0ac693a0f5060e6f170b4880b588ea35ceb0ade5 GIT binary patch literal 5128 zcmeHL`B#(I);=K@f+EB^;T1Ld)$i+VxnOT;5d@N2pw7X{5J*B2i%O9pVF+OgiM2|F zHgvcKD+nqVkpvP12|@@7BA}wgfiNZz!5DcN0_qzekmSa$`ybr({nFJRp0(e#*FNj4 zbIyLBy`O#l2!5~g%1tW)0M7gO1sw&z&h}{s935=tZAP!jW>zrvMWq7Z(*6#JF8Yn* zHs@c{f+N#H=_k`z$5KuJ7K`N>mlU5GbBuAqlb#Y=JmbF!fVCI)2ki;VD4Ev8*VeGu zkLL`7K_7LHPe)wacjvRde^NelIPS3eW(D`kG;R9h>BtMNHAi3Plw zg)K3qG2@vB;hWI=Dm~#6J%(2kpx8PUMx_Q+W~IXqq5X+^xf2-HTlgC@sBkIN42=u% zw@||=k6UW9qTn$oSQXR11qHT_UAINBn299DIqlz23VgTwG9jE(qx%#KHZwU#WU{PO zxQE}kj#pB?5rl{>Uv}@YzP=EP;F=f0;8azyz%8Owx1DzsoWab7i@UJBy zD~x_4m#vEul)nc?BV{5JkJsrB7(ZDK!e{}y+V}1ylv*gjh%I;Wy?}z4TVZO0OrLF_ zj)yIk3*=PuA^6t%J`}fH`=Lrm!VVhaRj%mNxppja_9>rWCTxD)3>g1p*JUNbeeJ~A zT03nW-+dc3dEX>L;cYq#(IZ%!-+qy2+nX$_IMIj&+J{NPR^f@tHe~8g{a~|@5^Bzy zQlo$#8iTTlyeD$v7Tov2F3>7Pg(`%w)Ax!V#a%HH!KO3y*UJ{R*=grINSIs=!haVy z^yX)XMDkpxzIYg=_*GyH3&?C&I)Ps`Lu(Lj!(O!5(2(Ago1;sqvncLi={4OoMZ7os zUGYk;>n*jzoY4Di4p0O}_oeX7_Qe@>hgV*+CIXl1NcB2jd z3wYsHQFGQ#Cp+Nw<_ErXa>n$7g(9)DJcsCp=X$_>lucw3;M1Dr$4LdxNdhY|Af*V0 z0-H;+h5Cj9H^=G!1D-Y5$mk~NZ-5&(dmeHV3@deQ(k2J(Vc!L$;w$(&XtZ?lj1pd@ zpbB#1LdF5en>e8wRvNFQuHf!%P@lgikpxK7lj~}%b|+mi;lpD;Yyfq zRF~^-^`tv!1yEoUR2I5qf@T`>Xw)QPHZbaD_@jZ|6pGrw;P z)s&oOdg%mJdntV`^NTOnfZ-63unSSka~B$FTIE>}o6Ad7^#W_IfL<~Y!{r!gClTD5 z^n-A@$9((ZbI41GPdzEdX?EdR4%$h9HS?Sy&=<+TG8|}9oBfo0RCZPOgMuO%!0qcI ziPkR8w#$>7y?|KRh5|(pp>gF&mslVv^8&+< z{>m-aKZPmlMT@t{sWsK3XKGVhLpHb_C;5{u!XyF&}0<*#VbDcYg+4B`t+%>m(l? zm)>@uEj8KR#)jn9U?ckL%?(+G1M!A1YW=g6B`VM|WG6Zr#6xku z&IqtsG#No&%D)UfSdRkSDlCzmRnZ_;S8bI)9RnY0IHWjDH%rh}bIS)DVwn$2V$&&b$4qxKe>%1i8#CUAT*p6pgk`r*oJS zLxHuITkQXQm_L3trd985HLgymIVh0!ZT*%#wYy#8zjwxI}_@742mUy(HRUIAO{Ej9%;yrR~S@Lu!q&kTdm*_p-6S0ij>6V-@ zjTk5@AmyTu^|xdp|D@~x|1x$flpR;mV10F9(oT^!KNChJ$IUqrh_2xJ(%2;gVq#o0xHx0H3_WxA$bIzts_EQDaumCoKtvnEqR0Qn`r)Frwt=7oopD_0% z3c!dQp`uHToYDL<ClX69MRD-HSqtEavPUyd>02W==dv1&T#T^Ue=4vb*=% z^``~Hzb+Wp#P2f>R+xV^r+eJD9^7u&Zgq7 zHsk^Bn|p!0IW$gX`5ux$uLIrmZ+Qf9jYT(fhC!6rjpU9b4JS$LUXpF{?Cb7etE#9B zaa(K}Y%h7WiWg2#SOKg*+i_(}zu|W;^jFcr+w1(*J|9`|aKU0408<@oRY<^cLFG!W z8_{!}&jAX>{H1XP;A%{ZP-h-zF0Bz*Zt~}~g}=BHC4aX}@GslCLN7mx`B^A?JPk2> z6&gai#Tt0wVgYt2#R^#O{e}B1n*_`8@Q+^6HMWQ|kh3B?01g7UQ1Fay2m%G_x`jOIz5^O(%NhuOOLsKvQ{y0pazrn=91$n$0y zoFnW+c(^iK(bQ|ji74`_^MH$-KL=q-ClLBIpiq!2%zEnJUh2(*IBm*+fAqlo zj1#5?AdhtKJxqyWC!+%q0Hq&+#OXYgm6&9ex|NA$sw`uk92el@gX{G)jMo<({+xF? z^2Pe>g(yI)x1F@l)9}2$KU(1_%5BK%+{)Ps2IQmFr36jGFh;HPzCsN*6X9OAKMK_D z+C@-S<;L#BwG2W#YNcW>}Dal`N16r+GlhQVdnqLYkZdw0oSGeJuCT{=+s)vO|VVHrtzb2X}+7Q7= zc)*GOi0?X-(z!V6j!jQ9>WYQ>mzG{o`=LDC+~l1xD}IFf+=H+KE6y7JUBSP`kX$Tf zLvPn&f-tJpN$Xo9(Qq$_eeBUQw3g7>`g$q&2#i*=|h( zhO~E6g8SG=b}HN#80iEggUZH)dd?M;b$1E4p^LaP8YQb`Cy@crUo9qK$L1fn#HGqK zBQ6>8q^jIHo$N;(DVlL_(k7x)=DY%m_`vF0_6ff+Lkjpy9 z^56}MDs?0~8+KL|3zrBb_O>y>93N?|7ZgdJw#oYfkh2T|0e6&57}*50%PE}h^hF%e z-1(qBY_B`mI@=2^2@E33iw8EPmzz^(8stxoCXqAwc|Q4wS?*E=nmC&WDvnGOq;;bON6X;%dtwW;pW%GnknP53J>Q zo?2wdj#n�TVA><`8V JiN2tH`)^X7+MWOa literal 0 HcmV?d00001 diff --git a/index.html b/docs/index.html similarity index 83% rename from index.html rename to docs/index.html index 0115745..90c016c 100644 --- a/index.html +++ b/docs/index.html @@ -5,9 +5,16 @@ - FIDE Player Selector + + FIDE Players Viewer +
+
+ Chess Icon +

FIDE Players

+
+

Use this tool to search for FIDE-rated chess players by name and country. Click on a player's row to view their profile on the FIDE ratings website.

@@ -89,6 +96,8 @@
+ +
+ + + +