fitztrev / fide

Experimental FIDE Api

Home Page:https://fide.thanh.se/docs/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Experimental FIDE API

How to use

Check Open API docs

Examples

Get all players

curl 'fide.thanh.se/api/players'

Get top 10 players by standard rating with descending order

curl 'fide.thanh.se/api/players?sort_by=standard&order=desc&size=10'

Get all players sort by blizt rating and is active on page 5

curl 'fide.thanh.se/api/players?sort_by=blitz&order=desc&page=5&is_active=true'

Development

Prerequisites:

  • Docker
  • JDK 21 with sbt

Run

cp .env.example .env
docker-compose up -d
sbt backend/run
open curl "http://localhost:9669/docs" // maybe you need to wait a bit for syncing

Test

sbt test

Before summiting PR

sbt prepare

TODO

TODO

About

Experimental FIDE Api

https://fide.thanh.se/docs/index.html

License:GNU Affero General Public License v3.0


Languages

Language:Scala 88.1%Language:Smithy 8.8%Language:PLpgSQL 2.7%Language:Procfile 0.4%