Skip to content

DigitalOutbreak/cramforge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

CramForge

CramForge is a clean, reusable study app starter for turning your own books into reader-friendly study material. It ships empty: no bundled books, no private course notes, and no baked-in AI provider.

Import a DRM-free EPUB, read it chapter by chapter, and let your own coding agent work from generated Markdown files to create summaries, flashcards, quizzes, cram notes, and cheat sheets.

What it does

  • Imports DRM-free EPUB files into a local chapter reader.
  • Keeps the catalog empty until users add their own material.
  • Supports reading, search, highlights, progress, and cheat sheet panels.
  • Creates AI-readable Markdown study packs for every imported book.
  • Avoids provider lock-in: users can generate study content with whatever AI agent or model they already use.

Quick start

cd learning-hub
npm install
npm run dev

Open http://localhost:3000/upload and import a DRM-free EPUB.

Study pack workflow

Every import creates:

learning-hub/study-materials/<book-slug>/README.md
learning-hub/study-materials/<book-slug>/chapters/chNN.md
learning-hub/study-materials/<book-slug>/study-guide.md
learning-hub/study-materials/<book-slug>/agent-instructions.md

Ask your AI/coding agent to read the study pack README and source chapter Markdown, then fill out study-guide.md with the study format you want.

Example prompt:

Read learning-hub/study-materials/<book-slug>/README.md and generate chapter
summaries, key terms, flashcards, multiple-choice quizzes, and cram notes in the
provided Markdown files.

Useful scripts

npm run dev
npm run build
npm run lint
npm run ingest:epub -- "/path/to/book.epub" book-slug --title "Book Title" --author "Author"
npm run catalog
npm run study-pack -- book-slug

Project layout

learning-hub/
  src/app/                 Next.js app routes
  src/content/books/       Imported book manifests and chapters
  public/books/            Imported book assets
  study-materials/         Markdown packs for AI-assisted study generation
  scripts/                 EPUB ingest, catalog, and study-pack utilities

Content policy

Only import books you have the right to use. CramForge intentionally starts with an empty content library so it can be reused for exam prep, certifications, internal training, and personal study without shipping copyrighted source books.

About

A reusable EPUB-to-study-pack app starter

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors