Skip to content

Kwash67/Study-Buddy

Repository files navigation

Study Buddy

Study Buddy is a PDF reading workspace with a built-in AI assistant. Open notes/slides, highlight text to explain, and chat with a local model via Ollama.

Features

  • PDF viewer: lazy page rendering, zoom controls, fullscreen mode, and scroll-based page tracking.
  • Selection actions (PDF only): highlight text inside the document to quickly copy or send an Explain prompt.
  • Local AI assistant (Ollama): detects local models, supports pulling new models, and keeps last-used model in local storage.
  • Image-aware chat: attach or drag-drop images into the chat prompt.
  • Workspace-style UI: tabbed files, explorer panel, search panel, activity bar, and resizable panes.

Tech Stack

Requirements

  • Node.js 18+
  • npm
  • Ollama running locally at http://localhost:11434

Getting Started

npm install
npm run dev

App runs at http://localhost:5173.

Ollama Setup

  1. Install and start Ollama.
  2. Pull at least one model, for example:
ollama pull llama3.2
  1. Open Study Buddy. The AI panel will automatically:
  • check Ollama connectivity,
  • list local models,
  • let you switch models or pull another model when needed.

Scripts

npm run dev      # start dev server
npm run build    # production build
npm run preview  # preview production build
npm run lint     # run eslint

Notes

  • The text-selection popup is scoped to PDF content only.
  • If Ollama is offline, the AI panel shows retry/setup states until it is reachable.

About

Pdf/pptx viewer with AI functionality

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors