https://github.com/soorajvp/inkedit
InkEdit is a web tool that lets you edit PDF and DOCX files directly from a URL using CKEditor. Quickly open, edit, and save documents online without any hassle.
https://github.com/soorajvp/inkedit
ckeditor5 document-editor vite-react
Last synced: 5 months ago
JSON representation
InkEdit is a web tool that lets you edit PDF and DOCX files directly from a URL using CKEditor. Quickly open, edit, and save documents online without any hassle.
- Host: GitHub
- URL: https://github.com/soorajvp/inkedit
- Owner: SoorajVp
- Created: 2024-10-30T05:24:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T05:20:26.000Z (over 1 year ago)
- Last Synced: 2025-02-27T01:54:48.675Z (12 months ago)
- Topics: ckeditor5, document-editor, vite-react
- Language: JavaScript
- Homepage:
- Size: 126 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Document Editor - INKEDIT
This template provides a minimal setup for a Document Editor built with **React** and **Vite**. It integrates **CKEditor** to deliver a user-friendly layout and rich text editing capabilities.
## Key Features
- **Rich Text Editing**: The CKEditor integration offers a customizable toolbar, enabling easy formatting, image insertion, and content management.
- **File Import/Export**: Import `.docx` documents and export your work in Word or PDF formats for seamless compatibility.
- **Fast Development**: Built with Vite, this project utilizes fast refresh for an efficient development process.
## Getting Started
### Prerequisites
Make sure you have **Node.js** and **npm** installed on your machine.
### Installation
- Clone the repository:
```bash
git clone https://github.com/SoorajVp/InkEdit.git
```
- Navigate to the project folder:
```bash
cd InkEdit
```
- Update environment credentials:
- Create a `.env` file in the root of your project.
```plaintext
InkEdit/
├── server/
├── src/
├── .env
├── package.json
└── ...
```
- Add your environment variables in the `.env` file:
```plaintext
VITE_CKEDITOR_LICENSE_KEY = 'YOUR_LICENSE_KEY'
VITE_CKBOX_TOKEN_URL = 'YOUR_CKBOX_TOKEN_URL'
```
- Install dependencies:
```bash
npm install
```
- To start the development server:
```bash
npm run dev
```
## Setup Server Side
- Navigate to the server folder:
```bash
cd server
```
- Install server dependencies:
```bash
npm install
```
- Start the backend server:
```bash
npm run dev
```
## Key Resources
- [CKEditor Documentation](https://ckeditor.com/docs/ckeditor5/latest/index.html) - Official documentation for CKEditor.
- [Vite Documentation](https://vitejs.dev/guide/) - Official guide for Vite.