{"id":17201520,"url":"https://github.com/lenguyenthanh/fide","last_synced_at":"2025-04-13T21:01:13.888Z","repository":{"id":231447143,"uuid":"781401330","full_name":"lenguyenthanh/fide","owner":"lenguyenthanh","description":"Experimental FIDE Api","archived":false,"fork":false,"pushed_at":"2025-04-10T00:28:25.000Z","size":630,"stargazers_count":8,"open_issues_count":11,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T05:59:09.295Z","etag":null,"topics":["cats","cats-effect","chess","fide","functional-programming","scala","skunk","smithy","smithy4s","typelevel"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lenguyenthanh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-03T10:06:00.000Z","updated_at":"2025-03-24T23:19:18.000Z","dependencies_parsed_at":"2025-02-05T10:21:10.167Z","dependency_job_id":"b553265e-0ac4-49da-a5e9-31430dcaff77","html_url":"https://github.com/lenguyenthanh/fide","commit_stats":null,"previous_names":["lenguyenthanh/fide"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenguyenthanh%2Ffide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenguyenthanh%2Ffide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenguyenthanh%2Ffide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenguyenthanh%2Ffide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lenguyenthanh","download_url":"https://codeload.github.com/lenguyenthanh/fide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248782272,"owners_count":21160716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cats","cats-effect","chess","fide","functional-programming","scala","skunk","smithy","smithy4s","typelevel"],"created_at":"2024-10-15T02:12:04.377Z","updated_at":"2025-04-13T21:01:13.713Z","avatar_url":"https://github.com/lenguyenthanh.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Experimental FIDE API\n\n[![Continuous Integration](https://github.com/lenguyenthanh/fide/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/lenguyenthanh/fide/actions/workflows/ci.yml)\n\n## How to use\n\nCheck [Open API docs](https://fide.lichess.dev/docs/index.html)\n\n## Development\n\n### Prerequisites:\n\n- Docker\n\n### Run\n\nAlso requires JDK 21 with [sbt](https://www.scala-sbt.org/1.x/docs/Setup.html)\n\n```bash\ncp .env.example .env\ndocker compose up -d\n```\n\nthen\n\n```bash\nexport $(cat .env | xargs) \u0026\u0026 sbt backend/run\n```\n\nor\n\n```bash\nsbt backend/stage\nexport $(cat .env | xargs) \u0026\u0026 ./modules/backend/target/universal/stage/bin/backend\n```\n\n### Usage\n\n```bash\nopen http://localhost:9669/docs\ncurl http://localhost:9669/api/players\n```\n\n### Database viewer\n\n```bash\nCOMPOSE_PROFILES=adminer docker compose up -d\n```\n\nhttp://localhost:8180/?pgsql=db\u0026username=admin\u0026db=fide\u0026ns=fide (password: dummy)\n\n\n### Stress test with Gatling\n\n```bash\ndocker compose -f docker-compose.gatling.yml up -d\nsbt gatling/gatling:test\n```\n\n### Before submitting PR\n\n```bash\nsbt test\nsbt lint\n```\n\n### release\n\n```bash\nsbt release with-defaults\n```\n\n## Run without building\n\nYou 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:\n\n```yaml\nname: fide\n\nservices:\n\n  api:\n    image: ghcr.io/lenguyenthanh/fide:latest\n    environment:\n      - HTTP_SHUTDOWN_TIMEOUT=1\n      - POSTGRES_HOST=db\n      - POSTGRES_PORT=5432\n      - POSTGRES_USER=admin\n      - POSTGRES_PASSWORD=dummy\n      - POSTGRES_DATABASE=fide\n    ports:\n      - 9669:9669\n    networks:\n      - fide_api\n    restart: unless-stopped\n\n  db:\n    image: postgres:16.2-alpine3.19\n    environment:\n      POSTGRES_DB: fide\n      POSTGRES_USER: admin\n      POSTGRES_PASSWORD: dummy\n    ports:\n      - 5432:5432\n    networks:\n      - fide_api\n    restart: unless-stopped\n\nnetworks:\n  fide_api:\n    driver: bridge\n```\n\nThen run:\n\n```bash\ndocker compose up -d\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flenguyenthanh%2Ffide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flenguyenthanh%2Ffide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flenguyenthanh%2Ffide/lists"}