Skip to content

KabirBose/AI-Flashcard-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flashcard Generator by Kabir Bose

A fast, terminal application that leverages Google's Gemini AI to generate flashcards/study notes with ease. It takes a PDF file as input, uses OCR to extract the text out of the PDF file, and uses detailed prompts to generate useful flashcards.

Setup

There are a couple things you need before using this program.

  1. Node.js --> Download it here!
  2. Google Gemini API key --> Get one here!
  3. GhostScript (You can install it locally or globally) --> download it here or here for Mac!
  4. Optional: Text Editor (I recommend Visual Studio Code) --> Download it here!

Usage

  1. Clone the repository --> git clone https://github.com/KabirBose/Flashcard-Generator
  2. Enter the directory with your terminal --> cd /YOUR/PATH/TO/flashcard-generator
  3. Install all the dependencies --> npm i or npm install
  4. Add PDF files that you want to convert into flashcards into the pdfs folder
  5. Run the program --> npm run dev

Screenshots

Here is an example of the input (a PDF file):

Input file

The program in process:

Commands

The output file (in Markdown language):

Ouput file

Preview of the output file:

Ouput file preview

Credits

Shoutout to the developers of Tesseract, GhostScript, Google Gemini, and JAGUARAVI (the creator of Node-PDF-OCR) for providing the tools I needed to develop this program.

About

Leverages Google's Gemini AI API to turn PDF study notes into detailed flashcards.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published