Skip to content

Latest commit

 

History

History
94 lines (72 loc) · 4.62 KB

README.md

File metadata and controls

94 lines (72 loc) · 4.62 KB
Raw
Screenshot 2024-04-25 at 11 04 53 AM

JotGenius

This project was built for LA Hacks 2024, see the Devpost here!

JotGenius gamifies the process of taking notes through timing, scoring, and suggesting improvements based on your notes -- all supported by Google Gemini. Learn more with educational videos, improve your timeliness and note content through LLM suggestions, and recall what you have learned in your dashboard of past videos.

Images / Examples
- -
YouTube Based Content Libary Custom Note Taking Page
Note Summary Page Custom Gemini Suggestions

Features

  • Simultaneous Note-taking: Users take notes in a bullet-point style while watching a YouTube video.
  • Dynamic Scoring: After the video ends, users receive a score out of 100 based on typing speed, content quality, and timeliness. The score is determined using Google's Gemini API and our WPM management system.
  • Timestamped Notes: Each note made by the user and sentence fragment in the transcript is timestamped with start time and duration.
  • Gemini Suggestions: Gemini API suggests improvements to the user's notes, which are linked to the notes themselves in order to improve long-lasting learning.
  • Video Library: Users are given access to a library of a variety of educational videos, curated by the authors.
  • Dashboard: Users can view all of their previously taken notes on their dashboard for review and further learning.

Technologies Used

Frontend

Next JS React

Backend

Python Flask

Future Plans

  • Allow users to enter their own YouTube links for note-taking.
  • Deploy the app for public use.
  • Scale up the app with additional functionality and features.

Installation

  1. Clone the repository.
  2. Download PocketBase from their website and follow installation instructions.
  3. Run PocketBase locally.
  4. Find the database schema (db-template) in the backend directory and use pb_schema_2.json to import the tables into local PocketBase UI.
    • With PocketBase running, navigate to the Admin Pannel (http://127.0.0.1:8090/_/).
    • Sign in, go to settings, and upload the schema.
  5. In PocketBase, create a user with the following attributes:

guest000account as ID

{
  "notes": [
    "h28xij0k9ni7ge8"
  ]
}

for note_library and set all other attributes at your discretion.

  1. Change directory into backend folder.
  2. Install the required dependencies using pip install -r requirements.txt.
  3. Create a file called contacts.py in the /backend folder and add a variable called gemini_api_key, setting it equal to your Gemini API key.
  4. Run the Flask server.
  5. Change directory into frontend folder.
  6. Run npm install
  7. Run npm run dev
  8. Access the web app in your browser.

Usage

  1. Sign in or sign up on the landing page.
  2. Choose a video from the available library.
  3. Start watching the video and take notes as prompted.
  4. After the video ends, review your score and Gemini suggestions.
  5. Access your dashboard to review all your previously taken notes, scores, and suggestions.
  6. Access your library to watch another video, and improve with Gemini's suggestions.

Contributors

  • Nathan Pietrantonio (@thenatepi)
  • Kyle Huynh (@huynh-kyle23)
  • Trystan Camden Vasquez (@trystancfv)