Skip to content

CLI application to create flashcards for memcode.com. Uses ChatGPT to convert markdown files with questions and answers into html formatted excel sheets ready for import into memcode.

License

Notifications You must be signed in to change notification settings

daniel-eder/flashcard-maker

Repository files navigation

Flashcard Maker

CLI application to create flashcards for memcode.com. Uses ChatGPT (GPT-4) to convert markdown files with questions and answers into html formatted excel sheets ready for import into memcode.

Install

  1. Install Node.js (https://nodejs.org/en/download/) - it is recommended to use the latest LTS version.
  2. Install/Activate Yarn Berry (https://yarnpkg.com/getting-started/install)
  3. Clone the repository: git clone [email protected]:daniel-eder/flashcard-maker.git
  4. Install dependencies: yarn install

Usage

  1. Run cp .env.example .env to create the environment file
  2. Enter your OpenAI API key in the .env file
  3. Run yarn start --input=<path to input markdown file> --output=<path to output excel file>
    • the aliases -i and -o can be used instead of --input and --output

Input Format

The input file must be a markdown file with the following format:

# Question 1
Full text answer that should be summarized for the flashcard.

# Question 2
Full text answer that should be summarized for the flashcard.

...

See also ./content/input.md for an example.

Prompt

The source code comes with a default prompt that is used to instruct ChatGPT on how to prepare the flashcards. The default prompt is in German and specific to my current subject and preferred formatting and structure.

You can change the prompt by editing ./data/prompt.txt.

Licensing

Copyright (c) 2023 Daniel Eder

Licensed under the MIT License, see LICENSE for more information.

About

CLI application to create flashcards for memcode.com. Uses ChatGPT to convert markdown files with questions and answers into html formatted excel sheets ready for import into memcode.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published