/flash-card-gpt

Flash Cards + GPT is an innovative browser extension designed to create flashcards on the fly while browsing web pages

Primary LanguageCSSMIT LicenseMIT

Flash Cards + GPT

Logo

Flash Cards + GPT is an innovative browser extension designed to create flashcards on the fly while browsing web pages. Simply highlight the text, click on the extension icon, and your flashcards are ready to use! This is an excellent tool for students and curious individuals who want to simplify the process of learning foreign languages or deepen their knowledge in various topics such as medicine or history.

Usage

  1. Go to the webpage from which you want to create a flashcard.
  2. Highlight the text you want to use to create a card.
  3. Click on the Flash Cards + GPT extension icon in the browser panel.
  4. Follow the instructions to create and save your flashcard.

Mode: "learning language"

Usage Example 1

Mode: "General"

Usage Example 2

Please replace <Link to your usage example 1 screenshot> and <Link to your usage example 2 screenshot> with the actual links to your screenshots showing examples of extension usage.

Functionality

  • Creating flashcards on the fly: You don't need to open a new tab or application to create cards. Just highlight the text and click on the extension icon.
  • Variety of topics: Whether you're learning a foreign language, researching a medical term, or just want to memorize an interesting fact from history, you can create a card on any topic.
  • Using AI (GPT): Our extension uses the latest achievements of artificial intelligence to optimize the process of creating cards.

Installation and Build

  1. Download and unpack the extension archive or clone the repository.
git clone git@github.com:dirusanov/flash-card-gpt.git
  1. Open the terminal and navigate to the project directory.
cd flash-card-gpt
  1. Install the necessary dependencies
npm install
  1. Build the project
npm run build
  1. Enter chrome://extensions/ in the address bar of the Chrome browser.
  2. Enable developer mode by clicking on the corresponding button.
  3. Click "Load unpacked extension" and select the build folder in your project directory.

OpenAI API Key

In order to use the AI functionality of Flash Cards + GPT, you will need to obtain an API key from OpenAI. Visit the OpenAI website and follow their instructions to sign up and get an API key.

Anki Desktop and AnkiConnect

For optimal use of our extension, we recommend installing the Anki desktop app and the AnkiConnect extension. These tools will allow your Flash Cards + GPT extension to communicate with Anki, making it easier to manage your flashcards.

  1. Download and install Anki desktop.
  2. Install AnkiConnect by following these steps:
    • Open Anki on your computer.
    • Go to the Tools menu and select Add-ons.
    • Click on Get Add-ons.
    • Paste the following code into the dialog box and click OK: 2055492159.

For more information about AnkiConnect, visit the AnkiConnect homepage.

Extension Settings

Once the extension is installed, you will need to configure it with your OpenAI API key and (optionally) AnkiConnect settings. To do this, click on the Flash Cards + GPT extension icon and go to the settings page.

Extension Settings

Support

If you have any issues or questions, please create a GitHub Issues.