tien-tran0906 / ai-study-assistant

AI-Google-Extension to create Q&A pairs to help you study

AI Study Assistant 📚💯

A Google extension that create Q&A pairs for you to meticulously prepare for any tests!

ScreenRecording2024-03-18at2.41.36AM-ezgif.com-video-speed.mov

(Video is 1.5x speed)

Project tree

Setup

• Install Ollama
• Create a virtual environment and activate it
• Run pip install -r requirements.txt
• Run ollama pull mistral:instruct (should say "success" at the end when the model is successfully pulled)

Setting up Google Credentials

• Watch this video and follow the instructions to enable both Google Drive and Google Docs API, get credentials.json (watch until 7:25)

• After getting your folder_id (video at 11:30), go to the "backend" directory and create a separate config.json file with the following format:

  {
    "folder_id": "PASTE_YOUR_FOLDER_ID_HERE"
  }
  

• Add the code to Google extension: https://www.youtube.com/watch?v=B8Ihv3xsWYs&t=2s (until 10:30)

Usage

• Run cd backend && uvicorn main:app --reload
• Use the extension! (Google is going to ask you to sign in to write to the doc)