Skip to content

karimsangid/cram

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cram — AI Study Assistant

By Hummus Development LLC

Drop your lecture slides, PDFs, and notes. Cram ingests them and lets you chat with your material, generates flashcards with spaced repetition, creates practice exams, and tracks your knowledge gaps. All powered by local AI through Ollama.

Features

  • Document Ingestion — Upload PDFs, PPTX, DOCX, TXT, Markdown, or images (OCR). Paste raw notes directly.
  • RAG Chat — Ask questions about your course material and get answers with source citations.
  • Flashcard Generation — Auto-generate flashcards from your material with SM-2 spaced repetition scheduling.
  • Practice Quizzes — Multiple choice, true/false, and short answer questions generated from your material.
  • Knowledge Tracking — See your weak topics, track accuracy over time, and get personalized study recommendations.
  • PWA — Works as a progressive web app, installable on desktop and mobile.

Tech Stack

  • Backend: Python, FastAPI, SQLite, ChromaDB
  • Frontend: Vanilla HTML/CSS/JavaScript (no build step)
  • AI: Ollama (local LLM inference) with qwen3:14b for chat and nomic-embed-text for embeddings
  • Architecture: REST API + WebSocket for streaming chat

Quickstart

Prerequisites

  1. Install Ollama
  2. Pull the required models:
    ollama pull qwen3:14b
    ollama pull nomic-embed-text

Run

pip install -r requirements.txt
python main.py

Then open http://localhost:5555 in your browser.

Usage

  1. Create a course
  2. Upload your lecture slides, PDFs, or paste notes
  3. Chat with your material, generate flashcards, or take a quiz
  4. Track your knowledge gaps and focus on weak areas

Architecture

[Browser UI] <--REST/WebSocket--> [FastAPI Backend] <--> [Ollama LLM] + [ChromaDB Vectors] + [SQLite DB]

API Endpoints

Method Endpoint Description
GET /api/health Health check
POST /api/courses Create a course
GET /api/courses List all courses
GET /api/courses/{id} Get course details
DELETE /api/courses/{id} Delete a course
POST /api/courses/{id}/upload Upload a document
POST /api/courses/{id}/paste Paste raw text
GET /api/courses/{id}/documents List documents
DELETE /api/documents/{id} Delete a document
POST /api/courses/{id}/chat Chat with material
POST /api/courses/{id}/flashcards/generate Generate flashcards
GET /api/courses/{id}/flashcards Get all flashcards
GET /api/courses/{id}/flashcards/due Get due flashcards
POST /api/flashcards/{id}/rate Rate a flashcard
POST /api/courses/{id}/quiz/generate Generate a quiz
GET /api/courses/{id}/quiz Get quiz questions
POST /api/quiz/{id}/answer Submit an answer
GET /api/courses/{id}/knowledge Get knowledge gaps
GET /api/courses/{id}/stats Get study stats
WS /ws/chat/{course_id} Streaming chat

License

MIT License

Copyright (c) 2026 Hummus Development LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

AI-powered study assistant — drop lecture slides, PDFs, and notes. Chat with your material, generate flashcards with spaced repetition, take practice quizzes, track knowledge gaps. By Hummus Development LLC.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors