fide

KO | EN

gitlite — search

#react #ai #golang #android #rust #deep-learning #linux #macos #awesome #cli #vue #ios #openai #open-source

(★ 14)

Experimental FIDE Api

fide 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Experimental FIDE API

[![Continuous Integration](https://github.com/lenguyenthanh/fide/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/lenguyenthanh/fide/actions/workflows/ci.yml)

## How to use

Check [Open API docs](https://fide.serginho.dev/docs/index.html) thanks [@SergioGlorias](https://github.com/SergioGlorias)

## Development

### Prerequisites:

- Docker

### Run

Also requires JDK 25 with [sbt](https://www.scala-sbt.org/1.x/docs/Setup.html)

```bash
cp .env.example .env
docker compose up -d
```

then

```bash
export $(cat .env | xargs) && sbt backend/run
```

or

```bash
sbt backend/stage
export $(cat .env | xargs) && ./modules/backend/target/universal/stage/bin/backend
```

### Usage

```bash
open http://localhost:9669/docs
curl http://localhost:9669/api/players
```

### Database viewer

```bash
COMPOSE_PROFILES=adminer docker compose up -d
```

http://localhost:8180/?pgsql=db&username=admin&db=fide&ns=fide (password: dummy)

### Stress test with Gatling

```bash
docker compose -f docker-compose.gatling.yml up -d
sbt gatling/gatling:test
```

### Before submitting PR

```bash
sbt test
sbt lint
```

### release

```bash
sbt release with-defaults
```

## Run without building

You can use a pre-built Docker image from [GitHub Container Registry](https://github.com/lenguyenthanh/fide/pkgs/container/fide). Here is an example of how to run it with docker-compose:

```yaml
name: fide

services:

api:
    image: ghcr.io/lenguyenthanh/fide:latest
    environment:
      - HTTP_SHUTDOWN_TIMEOUT=1
      - POSTGRES_HOST=db
      - POSTGRES_PORT=5432
      - POSTGRES_USER=admin
      - POSTGRES_PASSWORD=dummy
      - POSTGRES_DATABASE=fide
    ports:
      - 9669:9669
    networks:
      - fide_api
    restart: unless-stopped

db:
    image: postgres:17.4-alpine
    environment:
      POSTGRES_DB: fide
      POSTGRES_USER: admin
      POSTGRES_PASSWORD: dummy
    ports:
      - 5432:5432
    networks:
      - fide_api
    restart: unless-stopped

networks:
  fide_api:
    driver: bridge
```

Then run:

```bash
docker compose up -d
```

## Run CLI without building

You can use the pre-built CLI Docker image from [GitHub Container Registry](https://github.com/lenguyenthanh/fide/pkgs/container/fide-cli) to ingest historical CSV files into the database.

### Native CLI binary

Each release also ships standalone Scala Native binaries (`fide-cli-<os>-<arch>`,
also as `.zip`) on the [Releases page](https://github.com/lenguyenthanh/fide/releases),
for `linux-x86_64`, `linux-aarch64`, `macos-x86_64` and `macos-aarch64`.

These binaries are **dynamically linked** against the TLS stack used for the
PostgreSQL connection — `s2n-tls`, `utf8proc`, and OpenSSL's `libcrypto.so.3` —
so those libraries must be present at runtime. Install them with your package
manager:

- **Arch:** `sudo pacman -S s2n-tls libutf8proc openssl`
- **Alpine:** `apk add gcompat libgcc libstdc++ s2n-tls utf8proc libcrypto3`
- **Ubuntu/Debian:** `s2n-tls` is not packaged, so install via
  [Linuxbrew](https://docs.brew.sh/Homebrew-on-Linux)
  (`brew install s2n utf8proc openssl@3`) and point the loader at it:
  `export LD_LIBRARY_PATH="$(brew --prefix)/lib:$(brew --prefix openssl@3)/lib"`.
- **macOS:** `brew install s2n utf8proc openssl@3`

If you'd rather not manage these dependencies, use a Docker image instead — either
the JVM image below, or the self-contained native Alpine image
`ghcr.io/lenguyenthanh/fide/fide-cli-native:latest-alpine` (TLS libs preinstalled).

### CSV Format

The CLI expects CSV files from [fide-rating-database](https://github.com/lenguyenthanh/fide-rating-database) with the following 16-column format:

```
id,fide_id,name,title,womenTitle,otherTitles,standard,standardK,rapid,rapidK,blitz,blitzK,gender,birthYear,active,federationId
```

- `id` — Internal player ID (auto-increment, stable across exports). Used as the primary key in PostgreSQL.
- `fide_id` — FIDE player ID, or empty for unresolved pre-1991 players.

After history ingest completes, the PostgreSQL sequence is reset to `max(id) + 1` so that the live crawler can generate new IDs for players discovered via FIDE's live feed.

### Ingest

Assuming CSV files are in `./csv-data` and the docker-compose Postgres is running:

```bash
docker run --rm \
  --network fide_fide \
  -v ./csv-data:/data \
  -e POSTGRES_HOST=fide_postgres \
  -e POSTGRES_PORT=5432 \
  -e POSTGRES_USER=admin \
  -e POSTGRES_PASSWORD=dummy \
  -e POSTGRES_DATABASE=fide \
  ghcr.io/lenguyenthanh/fide-cli:latest \
  ingest /data --start 2024-01 --end 2024-12
```

### Test

Smoke-test ingested data against a running backend by sampling players from the CSV files and comparing API responses:

```bash
docker run --rm \
  --network fide_fide \
  -v ./csv-data:/data \
  -e POSTGRES_HOST=fide_postgres \
  -e POSTGRES_PORT=5432 \
  -e POSTGRES_USER=admin \
  -e POSTGRES_PASSWORD=dummy \
  -e POSTGRES_DATABASE=fide \
  ghcr.io/lenguyenthanh/fide-cli:latest \
  test /data --start 2024-01 --end 2024-12 --url http://api:9669
```

Options:
- `--start` / `--end` — Filter months to test
- `--url` — Backend URL (default: `http://localhost:9669`)
- `--sample-size` — Players to sample per month (default: 50)
- `--concurrency` — Concurrent HTTP requests (default: 10)

fide

fide 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

fide

fide 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README