This is exactly the same text in the proposal submission.
In this course project, we tried to build a customizable spaced repetition chess repertoire reviewing platform in the spirit of Chessable. The goal is to allow users to build up their own repertoire and annotations and do spaced repetition over those lines.
The most similar publically available resource is Chessable. Chessable has content created by experienced (often titled) players that can be purchased and learned with spaced repetition. However, users are not allowed to create their private repertoire. A spaced repetition tool that allows customized repertoire is ChessHQ, but they have very limited personalization functionalities and don't allow the users to annotate their moves. This project only aims to limit the scope to a locally hosted server-style platform, but at the same time optimize the customization ability of the repertoires being learned.
The project should rely on usual package building tools, so dune should be used as in the assignment. Also, this project will rely on yojson to serialize internal states like board state on the server side, etc. For chess-related .pgn files parsing we might build upon existing parsers like rgrinberg/ocaml-pgn, but none of them seems to be well documented and comprehensive, as most of them are for personal usage and do not have complete parsing functionality that supports all sorts of annotations). As a web application, we may want to use dream as a web framework, and possibly to use mostly ReScript for interface programming. As deemed proper we may need to write external bindings for React packages like react-chessaboard.
This is deprecated as it uses a lot of deprecated packages (an implementation from 9 years ago).
- Backend file processing,
.pgnfunction parsing, import export. - Internal representation of repertoire and lines, the
.mlispecified types and functionalities. - A backend commandline that can process
.pgnfiles and generate repertoire serializations. - User interface for input lines.
- User interface for input moves and get feedbacks.
- Server that respond to user review inputs etc.
- Glue everything and produce a working system.
Notice that the part depends on OCaml only lives inside /chessable_ocaml folder, so it make sense to start the building process there. Under the /chessable_ocaml directory, use the command
dune build
For the interface part you may need to run npm install before you are able to run the project and rescript build. To compile Rescript to Javascript, run
npx rescript
To use the local chessable file, you need to have at least one .pgn file to generate the repertoire from. There are some example .pgn file in the /data directory. To merge a .pgn file into a repertoire json file, run the command
./chessable.exe input [REPERTOIRE] --pgn [PGN_FILE]
You should be able to run this over multiple pgn files one by one, and if the repertoire file you pointed to does not exist, the chessable.exe runnable will generate one for you.
To serve a repertoire file, still run the same script with different task parameter:
./chessable.exe serve [REPERTOIRE]
This will serve the repertoire file at a given port (pre-specified)
To perform actual review, one need to run the react interface under /interface. To start an interface enter the /interface directory, and run the npm command:
npm start
This should pop up a web browser window at http://localhost:3000/ that you can perform review.