PDF Editor

Welcome to the PDF Editor project! This open-source project aims to provide a feature-rich PDF editor implemented using SvelteKit. The goal is to create a versatile tool for viewing, annotating, and editing PDF documents, with an emphasis on simplicity, performance, and extensibility.

Note: Most of the code is from kywch/pdf-editor I modified the pen annotation to be able to draw on the page directly. Currently working on improving the pen annotation.

Personal Goals:

• Adding Realtime collab

Note from Author:

• Will be using this in my project hopefully this code can be of use to anyone else. feel free to modify the code to your needs. building a all-use-case-editor is quite a challenge. maybe will return to continue the project.

Features

• View PDF documents with smooth navigation.
• Annotate PDFs with Text and Direct Drawing
• Save and load annotations in a Array that can stored either using Localstorage or External DB saved as JSON
• Export annotated PDFs.

Getting Started

To get started with contributing to the PDF Editor project, follow these steps:

1. Clone the Repository: git clone https://github.com/your-username/pdf-editor.git cd pdf-editor

2. Install Dependencies: npm install

3. Start Development Server: npm run dev

4. Contribute:

• Check out the issues tab for tasks and features that need attention.
• Fork the repository, create a new branch, and make your changes.
• Submit a pull request with your changes and a detailed description.

Contributing Guidelines

Thank you for considering contributing to the PDF Editor project! To ensure smooth collaboration, please adhere to the following guidelines:

• Follow Code Style: Maintain consistent code style and formatting.
• Write Tests: If applicable, include tests for your changes to ensure they function as expected.
• Document Changes: Document any new features, changes, or configuration updates in the appropriate files or in the README.md.
• Be Respectful: Respect other contributors and maintain a positive and constructive attitude.

License

This project is licensed under the MIT License.

Contact

If you have any questions, suggestions, or feedback, feel free to reach out to us via email or by opening an issue on GitHub.

We look forward to your contributions and hope you enjoy working on the PDF Editor project!

Credits

The implementation of certain features in this project was adapted from the kywch/pdf-editor repository. We appreciate their contributions to the open-source community.

Specifically, we borrowed code for [offline-pdf-editor] from the following files:

• Whole Functionality

We thank the contributors to the kywch/pdf-editor project for their valuable work.