https://github.com/jongear/redact-check
Detect and fix improperly redacted PDFs where content was visually hidden but not actually removed.
https://github.com/jongear/redact-check
pdf redaction
Last synced: 5 months ago
JSON representation
Detect and fix improperly redacted PDFs where content was visually hidden but not actually removed.
- Host: GitHub
- URL: https://github.com/jongear/redact-check
- Owner: jongear
- Created: 2025-12-30T04:07:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-13T05:44:39.000Z (5 months ago)
- Last Synced: 2026-01-16T08:04:27.302Z (5 months ago)
- Topics: pdf, redaction
- Language: TypeScript
- Homepage: https://jongear.github.io/redact-check/
- Size: 563 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔒 redact-check
> Detect and fix improperly redacted PDFs where content was visually hidden but not actually removed.
[](https://jongear.github.io/redact-check/)
[](LICENSE)
[](https://github.com/jongear/redact-check/actions)
## 🎯 Overview
**redact-check** is a client-side PDF analysis and cleaning tool that identifies risky redactions in PDF documents. Many PDFs use visual redaction (black boxes) without actually removing the underlying text—this tool detects those vulnerabilities using heuristics and provides automated cleaning.
**🌐 [Try it now →](https://jongear.github.io/redact-check/)**
## ✨ Features
- 🔒 **100% Client-side** — Your PDFs never leave your browser
- 🔍 **Smart Detection** — Identifies content that appears redacted but remains in the PDF
- 📊 **Risk Assessment** — Categorizes findings by risk level (High, Medium, Low, None)
- 🧹 **Auto-Clean** — Export cleaned PDFs with problematic content removed
- 📋 **Audit Logs** — Download detailed audit reports in JSON format
- ⚡ **Fast & Secure** — No server uploads, all processing happens locally
## 🚀 Quick Start
### Prerequisites
- Node.js 16+ and npm
### Installation & Development
```bash
# Clone the repository
git clone git@github.com:jongear/redact-check.git
cd redact-check
# Install dependencies
npm install
# or
make install
# Start development server
npm run dev
# or
make dev
```
The app will be available at `http://localhost:5173`
### Available Commands
| Command | NPM | Make | Description |
|---------|-----|------|-------------|
| **Install** | `npm install` | `make install` | Install dependencies |
| **Dev** | `npm run dev` | `make dev` | Start development server |
| **Build** | `npm run build` | `make build` | Build for production |
| **Preview** | `npm run preview` | `make preview` | Preview production build |
| **Clean** | — | `make clean` | Remove build artifacts |
| **Help** | — | `make help` | Show all make commands |
## 📖 How It Works
1. 📤 **Upload** a PDF file (stays in your browser)
2. 🔍 **Analyze** the PDF to detect potentially hidden redactions
3. 📊 **Review** flagged pages with detailed risk assessments
4. 🧹 **Clean** and export a new PDF with risky content removed
5. 💾 **Download** the cleaned PDF and audit log
## 🛠️ Tech Stack
- **[React 19](https://react.dev/)** — Modern UI framework
- **[TypeScript](https://www.typescriptlang.org/)** — Type-safe development
- **[Vite](https://vitejs.dev/)** — Lightning-fast build tool and dev server
- **[PDF.js](https://mozilla.github.io/pdf.js/)** — PDF parsing and text extraction
- **[pdf-lib](https://pdf-lib.js.org/)** — PDF manipulation and cleaning
## ⚠️ Security Notice
This tool detects **improperly redacted** PDFs where content was visually hidden but not removed. It **cannot** recover text from properly redacted PDFs where the content was actually deleted. Always use proper redaction tools (Adobe Acrobat, etc.) when handling sensitive documents.
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## 📝 License
MIT License - see [LICENSE](LICENSE) for details
## 💖 Support
If you find this tool useful, consider supporting its development:
[](https://www.buymeacoffee.com/jongear)
---
**Made with ❤️ by [jongear](https://github.com/jongear)**