Skip to content

nottherealtar/TerrificOCR

Repository files navigation

TerrificOCR

TerrificOCR Logo

Fast, Accurate, and Beautiful OCR for PDF Documents

Windows License: MIT Electron React Tesseract

DownloadDocumentationReport BugRequest Feature


✨ Features

  • 📄 Single & Batch Processing - Process one PDF or hundreds at once
  • 🎯 Drag & Drop Interface - Simply drag PDFs into the app
  • 🌍 Multi-Language Support - English, Chinese, French, German, Japanese, Korean
  • 👁️ Live Preview - View extracted text instantly with syntax highlighting
  • 🔍 Smart Search - Find and navigate through extracted text
  • 📊 Real-Time Progress - Track processing status for each file
  • 💾 Multiple Formats - Export as TXT, Markdown, JSON, or Searchable PDF
  • Fast & Accurate - Powered by Tesseract 5.5 OCR engine
  • 🎨 Modern UI - Beautiful gradient design with smooth animations
  • 📦 Standalone - No prerequisites needed, everything bundled

🚀 Quick Start

Download & Install

  1. Download the latest release: TerrificOCR-Setup-0.0.1.exe
  2. Run the installer
  3. Launch TerrificOCR
  4. Start processing PDFs!

That's it! No Python, no Tesseract, no configuration needed.

First Use

  1. Add Files - Drag PDF files into the app or click "Browse Files"
  2. Configure - Choose output format and language
  3. Process - Click "Start Processing" and watch the magic happen
  4. View Results - Click "View Output" to see extracted text
  5. Search - Use the search bar to find specific text

📸 Screenshots

Main Interface

Main Interface

Processing Queue

Processing

Output Preview with Search

Preview

🛠️ Tech Stack

  • Frontend: React 18, Vite
  • Desktop: Electron 28
  • OCR Engine: Tesseract 5.5
  • PDF Processing: PyMuPDF (fitz)
  • Backend: Python 3.11 (embedded)
  • UI Framework: Custom CSS with gradient design

📦 What's Included

The standalone installer bundles everything you need:

  • ✅ Electron app with React UI
  • ✅ Python 3.11 runtime (embedded)
  • ✅ Tesseract OCR 5.5 with language data
  • ✅ All Python packages pre-installed
  • ✅ No external dependencies required

Download Size: ~250 MB
Installation Size: ~260 MB

🌍 Supported Languages

  • 🇬🇧 English
  • 🇨🇳 Chinese (Simplified)
  • 🇫🇷 French
  • 🇩🇪 German
  • 🇯🇵 Japanese
  • 🇰🇷 Korean

More languages can be added easily!

📖 Documentation

🔧 For Developers

Prerequisites

  • Node.js 18+
  • Python 3.8+
  • Tesseract OCR

Setup

# Clone the repository
git clone https://github.com/nottherealtar/TerrificOCR.git
cd TerrificOCR

# Install dependencies
npm install

# Setup bundled components (for standalone build)
npm run setup:bundled
npm run copy:tesseract

# Run in development mode
npm run dev

Build

# Build standalone installer
npm run build:standalone

# Output: dist-v1/TerrificOCR-Setup-0.0.1.exe

Version Management

# Bug fixes (0.0.1 → 0.0.2)
npm run version:patch

# New features (0.0.1 → 0.1.0)
npm run version:minor

# Major release (0.0.1 → 1.0.0)
npm run version:major

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

📊 Project Stats

GitHub release (latest by date) GitHub all releases GitHub stars GitHub forks

🐛 Known Issues

See the Issues page for known bugs and feature requests.

📮 Contact


Made with ❤️ for the OCR community

⬆ Back to Top