explaingit

zjuhechao/exam-porridge-assistant

21TypeScriptAudience · generalComplexity · 2/5Setup · easy

TLDR

A browser-based study tool that turns your uploaded notes, PDFs, and images into AI-generated outlines, flashcards, and practice questions, with a drill mode that tracks your wrong answers so you focus on what you actually need to review.

Mindmap

mindmap
  root((repo))
    What it does
      Upload study materials
      Generate practice questions
      Drill mode for mistakes
      Course-based organization
    Tech stack
      TypeScript and React 18
      Tailwind CSS
      IndexedDB via Dexie
      Node.js dev server
    AI providers
      DeepSeek
      Tongyi Qianwen
      OpenAI
    Use cases
      Exam prep
      Self-paced review
      Error-focused practice
      Multi-format import
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Upload lecture slides or textbook PDFs and instantly get a study outline and practice questions without manual summarizing.

USE CASE 2

Run timed drill sessions before an exam and let the app automatically track which questions you got wrong for targeted follow-up.

USE CASE 3

Import photos of handwritten notes or printed worksheets and have the AI convert and turn them into a quiz.

USE CASE 4

Organize study materials by course and review everything offline with no data ever leaving your own computer.

Tech stack

TypeScriptReact 18Tailwind CSSIndexedDBDexieNode.js

Getting it running

Difficulty · easy Time to first run · 30min

Run a local Node.js dev server and open in your browser. Bring your own API key from DeepSeek, OpenAI, or Tongyi Qianwen. No backend or account needed. Beginner-friendly instructions included for Windows, macOS, and Linux.

No license information was mentioned in the explanation.

In plain English

Exam Porridge Assistant is a study and exam preparation tool that runs locally in your browser. You upload learning materials such as PDFs, Word documents, text files, or images, and it uses an AI language model to generate review outlines, study notes, and practice questions from the content. Practice questions can be multiple choice, fill-in-the-blank, true or false, or short answer. The README is written in Chinese and the tool appears to target Chinese-language learners and students. The tool also includes a drill mode where you work through a question set and have wrong answers tracked automatically. Those tracked errors feed into targeted follow-up practice, so you spend more time on material you got wrong. Study data is organized by course and stored entirely in your browser's local storage, with nothing sent to any external server. Clearing your browser data would delete all stored records. To use the AI features, you supply your own API key from a supported provider, such as DeepSeek, Alibaba's Tongyi Qianwen, or OpenAI. The application calls that API directly from your browser on demand. OCR (converting images of text into editable text) requires a key from a provider whose model supports image input. The README walks through getting a DeepSeek key as the primary example. The application is built with TypeScript, React 18, and Tailwind CSS. Local data is stored using IndexedDB through a library called Dexie. It runs on a local development server you start with a Node.js command and then access in your browser at a local address. The README includes detailed setup instructions aimed at users with no prior coding experience, covering Windows, macOS, and Linux.

Copy-paste prompts

Prompt 1
I'm using the Exam Porridge Assistant app locally. I've uploaded a PDF chapter on cellular respiration. Write me 10 mixed-format practice questions (multiple choice, true/false, short answer) at a difficulty suitable for a high school biology exam.
Prompt 2
I'm setting up Exam Porridge Assistant and need a DeepSeek API key. Walk me through creating a free DeepSeek account and finding my API key so I can paste it into the app.
Prompt 3
Using Exam Porridge Assistant, I've completed a drill session and got 8 questions wrong on the topic of World War II timelines. Generate a focused 5-question follow-up quiz that specifically targets those weak areas.
Prompt 4
I want to use Exam Porridge Assistant with OpenAI instead of DeepSeek. What model should I choose for best results on exam question generation, and how do I get my API key from the OpenAI platform?
Prompt 5
Explain how Exam Porridge Assistant stores my study data. What happens if I clear my browser cache, and how can I back up my progress before that happens?
Open on GitHub → Explain another repo

← zjuhechao on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.