Repository navigation
About
Release of the beta version 1 of the Anki GPT integration tool. The software is under preliminary testing with this release.
Features:
- Run the project backend in a Docker server and the built frontend using the
servepackage in npm. - Setup and run the project with two shell scripts provided
- Upload a PDF file containing notes. The file then gets parsed to plain text and sent to the ChatGPT API to generate question/answer pairs based on the notes. Thanks to the AnkiConnect add-on, these notes are then added to the local Anki deck specified
- WebSocket (Socket.IO) allows for the web app to be synchronized with an Anki instance running locally. This way, you can view the details of the card on the web app while having it open on Anki
- After the WebSocket reads the current opened card on Anki, the user has the option to 'answer' a question. The GPT model 'grades' your inputted answer and gives it a score. The user can read the feedback and decide accordingly the appropriate next interval for the spaced repetition on the card
- Finally, an open AI key can be generated and put into a
.envfile for each user. The setup shell script will copy the environment variables into the Docker container.
Full Changelog: https://github.com/ryanarnouk/AnkiGPTIntegration/commits/v1.0.0-beta