Currently ~15% functional - PDF viewing works, editing features broken
- Overview
- Quick Start
- Features
- Documentation
- System Requirements
- Technology Stack
- Contributing
- License
- Support
What Actually Works:
- ✅ PDF file loading and viewing
- ✅ Build system and application launch
- ✅ Adobe-style dark theme UI
What's Broken Despite Claims:
- ❌ PDF text editing (visual overlays only)
- ❌ Annotations (don't persist to files)
- ❌ Digital signatures (mock implementation)
- ❌ OCR integration (service exists but disconnected)
- ❌ Form editing (UI placeholders only)
This guide will help you get started with the Professional PDF Editor project. It provides an overview of the project and its documentation, and it will help you to get up and running quickly.
# Clone the repository
git clone https://github.com/your-org/pdf-editor.git
cd pdf-editor# Install all dependencies
npm install# Start the application in development mode
npm run devThe documentation for this project is very comprehensive. It's a good idea to familiarize yourself with the documentation before you start working on the project.
Here are some of the key documents that you should read:
- AI Onboarding Guide - This document provides a guide for AI agents working on the project.
- Architecture Overview - This document provides a high-level overview of the project's architecture.
- API Reference - This document provides a detailed overview of the project's API.
- Development Guide - This document provides a detailed overview of the project's development process.
- Security Guide - This document provides a detailed overview of the project's security.
This project is licensed under the MIT License - see the LICENSE file for details.
Q: How do I get started with the project?
A: The best way to get started with the project is to read the "Getting Started" guide in this README.md file. This guide will provide you with an overview of the project and its documentation, and it will help you to get up and running quickly.
Q: Where can I find the documentation for the project?
A: The documentation for the project is located in the docs directory. The documentation is very comprehensive and it covers all aspects of the project, from the high-level architecture to the low-level implementation details.
Q: How can I contribute to the project?
A: We welcome contributions to the project. Please see our Contributing Guide for details.
Website • Documentation • Blog