chessXplain

Chessxplain is open source working prototype that demonstrates AI models can explain chess concepts

Acknowledgements

• React Chessboard
• Chess.js
• Stockfish API
• Stockfish
• Lichess API
• Lichess Opening Explorer
• Lichess Games Database
• Google Prompt Guide
• Material-UI

Design

Features

• Light/dark mode toggle
• Custom board colors
• Chess position analysis with Stockfish
• Auto play topline support
• Auto Stockfish lines, bestmove, eval with GPT commentary
• Live analysis board
• Lichess game text based evaluation by chatGPT 3.5
• Support For GPT 3.5, Bard, GPT Conversation trained model

Environment Variables

To run this project, you will need to add the following environment variable to your .env file in chessxplain/backend/.env

REACT_APP_GPT_TOKEN

Run Frontend Locally

Clone the project

  git clone https://github.com/jalpp/chessxplain.git

Go to the project directory

  cd chessxplain

  cd chessxplain/src

Install dependencies

  npm install

Start the site

  npm run start

Run Backend Locally

cd chessxplain/backend

node server.js

The server should start at port 5019

ChessXplain API

chessxplain backend exposes API for clients to get chess AI explanations in REST Protocol, hit API URL https://chessxplain.thexhosting.com/api

GET gpt text eval based on fen

send GET request to 
https://chessxplain.thexhosting.com/api/gpt?fen={your fen}

GET bard text eval based on fen

send GET request to 
https://chessxplain.thexhosting.com/api/bard?fen={your fen}

GET GPT Convo model text eval based on fen

send GET request to 
https://chessxplain.thexhosting.com/api/convo?fen={your fen}

GET GPT model text based game review for Lichess game

send GET request to 
https://chessxplain.thexhosting.com/api/gamereview?gameurl={lichess game}

Screenshots

Roadmap

• Lichess puzzle eval by AI

• Lichess study eval by AI

• PGN support

• Better UI

• More API endpoints

Authors:

@jalpp