GeniusDeck

An AI-powered flashcard study tool originally made in 48 hours for the Fall 2023 Hackathon and improved for MICS 2024.

It can process PDF files and YouTube links into flashcards for studying using GPT-3.5. Users can also download their flashcard data and access it later by uploading it back onto the website.

• Frontend:​
  • Next.js​
  • Material UI​
  • Tailwind​
• Backend:​
  • Flask​

Running the project

To run the frontend, navigate to the client folder and type "npm install" if you're running it for the first time. Then type "npm run dev" and connect to localhost:3000 to view it in action.

To run the backend, place a .env file with your OpenAPI token in the root directory(?). If you're running this for the first time you can install the necessary packages by running "pip install -r Requirements.txt". FFMPEG is also required and must be installed separately. You can download it here: https://ffmpeg.org/download.html. Then navigate to the backend folder and run "python app.py". The server will be available at localhost:5000.

GeniusDeck API Documentation

The GeniusDeck API allows users to upload PDF documents, send YouTube video links, generate flashcards from uploaded PDFs, and retrieve flashcard data.

Table of Contents

1. Upload PDF
2. Send YouTube URL
3. Generate Flashcards
4. Get Flashcard Data

Upload Materials

Endpoint: /upload
Method: POST

Request

• Form Data:
  • file: PDF, TXT, or PPTX file to be uploaded.

Response

• JSON Object:
  • If successful:

    {
      "id": "your_file_unique_id"
    }

  • If error:

    {
      "error": "No file part" 
    }

Send YouTube URL

Endpoint: /sendyoutubeurl
Method: POST

Request

• Query Parameter:
  • url: YouTube video URL.

Response

• JSON Object:

  {
    "id": "your_unique_id"
  }

Generate Flashcards

Endpoint: /generatecards
Method: GET

Request

• Query Parameters:
  • id: Unique identifier for the flashcard generation.
  • dataformat: Format of data to be processed can be "pdf" or "yt".

Response

• JSON Object:

  {
    "id": "your-unique-id"
  }

Note

• Flashcards are generated based on the PDF data specified by the id and dataformat parameters.

Get Flashcard Data

Endpoint: /getflashcarddata
Method: GET

Request

• Query Parameter:
  • id: Unique identifier for the flashcard data.

Response

• JSON Object:
  • If successful:

    [
      [
        {
          "question": "What is the movie being discussed in the text?",
          "answer": "Inception"
        },
        {
          "question": "Who is the director of the movie?",
          "answer": "Christopher Nolan"
        },
        {
          "question": "What is one of the unique auditory elements in the movie?",
          "answer": "The \"BRAAAM\" sound or \"Inception horn\""
        }
      ],
      [
        {
          "question": "What are three visual aspects that spark curiosity in the opening sequence?",
          "answer": "The starting sequence uses visuals to spark curiosity in the minds of viewers."
        },
        {
          "question": "How is the protagonist, Cobb, introduced in the movie?",
          "answer": "Cobb is introduced as a troubled person lost in the sea and later as a skilled professional selling his services."
        },
        {
          "question": "How does the director establish the motives of the characters in the exposition?",
          "answer": "The director efficiently establishes the motives of the characters through flashbacks, dialogue, and character interactions."
        }
      ],
      [
        {
          "question": "What movie is the text talking about?",
          "answer": "Inception."
        },
        {
          "question": "Who is the director of Inception?",
          "answer": "Christopher Nolan."
        },
        {
          "question": "How does the director hook the audience in the opening minutes?",
          "answer": "By raising a lot of questions and tying everything together by the end."
        }
      ]
    ]

  • If error:

    {
      "error": "ID parameter is missing"
    }

Example

curl http://127.0.0.1:5000/getflashcarddata?id=1

[
  [
    {
      "question": "What is the movie being discussed in the text?",
      "answer": "Inception"
    },
    {
      "question": "Who is the director of the movie?",
      "answer": "Christopher Nolan"
    },
    {
      "question": "What is one of the unique auditory elements in the movie?",
      "answer": "The \"BRAAAM\" sound or \"Inception horn\""
    }
  ],
  [
    {
      "question": "What are three visual aspects that spark curiosity in the opening sequence?",
      "answer": "The starting sequence uses visuals to spark curiosity in the minds of viewers."
    },
    {
      "question": "How is the protagonist, Cobb, introduced in the movie?",
      "answer": "Cobb is introduced as a troubled person lost in the sea and later as a skilled professional selling his services."
    },
    {
      "question": "How does the director establish the motives of the characters in the exposition?",
      "answer": "The director efficiently establishes the motives of the characters through flashbacks, dialogue, and character interactions."
    }
  ],
  [
    {
      "question": "What movie is the text talking about?",
      "answer": "Inception."
    },
    {
      "question": "Who is the director of Inception?",
      "answer": "Christopher Nolan."
    },
    {
      "question": "How does the director hook the audience in the opening minutes?",
      "answer": "By raising a lot of questions and tying everything together by the end."
    }
  ]
]