{"id":18997397,"url":"https://github.com/jalpp/chessxplain","last_synced_at":"2025-06-13T02:38:22.236Z","repository":{"id":223758836,"uuid":"759223455","full_name":"jalpp/chessxplain","owner":"jalpp","description":"Working Prototype for AI models to explain chess concepts","archived":false,"fork":false,"pushed_at":"2024-10-24T12:09:48.000Z","size":1996,"stargazers_count":8,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-25T11:03:33.865Z","etag":null,"topics":["ai","api","chess","gen-ai","gpt","lichess","nodejs","prompt-engineering"],"latest_commit_sha":null,"homepage":"https://chessxplain.netlify.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jalpp.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-02-18T01:34:01.000Z","updated_at":"2024-10-24T12:09:51.000Z","dependencies_parsed_at":"2024-04-22T01:52:29.070Z","dependency_job_id":null,"html_url":"https://github.com/jalpp/chessxplain","commit_stats":null,"previous_names":["jalpp/chessxplain"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalpp%2Fchessxplain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalpp%2Fchessxplain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalpp%2Fchessxplain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalpp%2Fchessxplain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jalpp","download_url":"https://codeload.github.com/jalpp/chessxplain/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223727898,"owners_count":17193039,"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":["ai","api","chess","gen-ai","gpt","lichess","nodejs","prompt-engineering"],"created_at":"2024-11-08T17:40:25.690Z","updated_at":"2024-11-08T17:40:26.296Z","avatar_url":"https://github.com/jalpp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n[![Netlify Status](https://api.netlify.com/api/v1/badges/310a8201-6453-448c-8651-e237d3c3b8f3/deploy-status)](https://app.netlify.com/sites/chessxplain/deploys)\n\n[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)\n\n# chessXplain\nChessxplain is open source working prototype that demonstrates AI models can explain chess concepts\n\n\n## Acknowledgements\n\n - [React Chessboard](https://github.com/Clariity/react-chessboard)\n - [Chess.js](https://unpkg.com/browse/chess.js@0.12.0/)\n - [Stockfish API](https://stockfish.online/)\n - [Stockfish](https://stockfishchess.org/)\n - [Lichess API](https://lichess.org/api)\n - [Lichess Opening Explorer](https://lichess.org/api#tag/Opening-Explorer)\n - [Lichess Games Database](https://lichess.org/api#tag/Games/operation/gamePgn)\n - [Google Prompt Guide](https://cloud.google.com/vertex-ai/docs/generative-ai/text/text-prompts)\n - [Material-UI](https://mui.com/material-ui/)\n\n\n## Design\n\n![chessxplain-design.png](./chessxplain/public/chessxplain-design.png)\n\n\n## Features\n\n- Light/dark mode toggle\n- Custom board colors\n- Chess position analysis with Stockfish\n- Auto play topline support\n- Auto Stockfish lines, bestmove, eval with GPT commentary \n- Live analysis board\n- Lichess game text based evaluation by chatGPT 3.5\n- Support For GPT 3.5, Bard, GPT Conversation trained model\n\n\n## Environment Variables\n\nTo run this project, you will need to add the following environment variable to your .env file\nin ``` chessxplain/backend/.env ```\n\n`REACT_APP_GPT_TOKEN`\n\n\n## Run Frontend Locally\n\nClone the project\n\n```bash\n  git clone https://github.com/jalpp/chessxplain.git\n```\n\nGo to the project directory\n\n```bash\n  cd chessxplain\n\n  cd chessxplain/src\n```\n\nInstall dependencies\n\n```bash\n  npm install\n```\n\nStart the site\n\n```bash\n  npm run start\n```\n\n## Run Backend Locally\n\n```\ncd chessxplain/backend\n\nnode server.js\n```\nThe server should start at port 5019\n\n\n## ChessXplain API\n\nchessxplain backend exposes API for clients to get chess AI explanations\nin REST Protocol, hit API URL ```https://chessxplain.thexhosting.com/api```\n\n### GET gpt text eval based on fen \n\n```\nsend GET request to \nhttps://chessxplain.thexhosting.com/api/gpt?fen={your fen}\n\n```\n\n### GET bard text eval based on fen\n\n```\nsend GET request to \nhttps://chessxplain.thexhosting.com/api/bard?fen={your fen}\n\n```\n\n### GET GPT Convo model text eval based on fen\n\n```\nsend GET request to \nhttps://chessxplain.thexhosting.com/api/convo?fen={your fen}\n\n```\n### GET GPT model text based game review for Lichess game\n\n```\nsend GET request to \nhttps://chessxplain.thexhosting.com/api/gamereview?gameurl={lichess game}\n\n```\n\n## Screenshots\n\n![screenshot1](./chessxplain/public/screenshot1.png)\n\n![screenshot2](./chessxplain/public/screenshot2.png)\n\n\n## Roadmap\n\n- Lichess puzzle eval by AI\n\n- Lichess study eval by AI\n\n- PGN support\n\n- Better UI\n\n- More API endpoints\n\n## Authors:\n\n@jalpp\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjalpp%2Fchessxplain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjalpp%2Fchessxplain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjalpp%2Fchessxplain/lists"}