DocTools

📋 Table of Contents

1. Introduction
2. Features
3. Tech Stack
4. Getting Started
5. License
6. Contributing
7. Contact

✨ Introduction

DocTools is an all-in-one document utility platform that lets you:

• Convert files across multiple formats
• Extract text from scanned documents and PDFs using GPT-4o
• Generate advanced AI-based document summaries using GPT-4.1
• Create instant QR codes

It’s powered by a FastAPI backend (with OpenAI models) and a Vite + React (TypeScript) frontend with a sleek UI built using Shadcn/UI and Tailwind CSS.

⚡ Features

👉 Multiple format conversion: Convert between PDF, DOCX, TXT, MD, and PPTX.
👉 OCR & text extraction: Extract content from scanned PDFs and images using GPT-4o.
👉 AI-powered summarization: Get deep insights and stronger summaries using GPT-4.1.
👉 QR code generator: Turn text/links into downloadable QR codes.
👉 Cloud-based: No installation required — access anytime, anywhere.
👉 Secure: Files are only processed temporarily (not stored).
👉 Responsive UI: Optimized for both desktop and mobile.

🛠 Tech Stack

💻 Frontend

• Vite – Lightning-fast build tool
• React – Component-based UI framework
• TypeScript – Type safety
• Tailwind CSS – Utility-first CSS
• Shadcn/UI – Modern UI components

⚙️ Backend

• FastAPI – High-performance API framework
• OpenAI API – AI-powered document analysis
• Pydantic – Data validation & parsing

🚀 Getting Started

Follow these steps to set up DocTools locally 👇

1. Clone the repository

git clone https://github.com/Mubassim-Khan/DocTools.git
cd DocTools

2. Backend Setup (FastAPI)

1. Navigate into the backend folder:

   cd backend

2. Create a Python virtual environment:

   python -m venv venv

3. Activate the virtual environment:

   • On Linux/Mac:

     source venv/bin/activate

   • On Windows:

     venv\Scripts\activate

4. Install dependencies:

   pip install -r requirements.txt

5. Run the FastAPI server:

   uvicorn app.main:app --reload

✅ Backend runs at: http://127.0.0.1:8000

---

3. Frontend Setup (Vite + React)

1. Navigate into the frontend folder:

   cd frontend

2. Install dependencies:

   npm install

3. Run the development server:

   npm run dev

✅ Frontend runs at: http://localhost:5173

---

4. Connect Frontend & Backend

Make sure your frontend .env file points to the correct backend URL:

VITE_API_URL=http://127.0.0.1:8000

5. Connect Backend with AI Model

Make sure your backend .env file points to the correct backend URL:

GITHUB_TOKEN_GPT_4_1=your_token
GITHUB_TOKEN_GPT_4o=your_token

📜 License

This project is licensed under the MIT License.

🤝 Contributing

Contributions are welcome! 🎉 If you find bugs 🐞 or have feature suggestions 💡, please open an issue or a pull request.

📬 Contact

For questions, suggestions, or feedback:

• LinkedIn: Mubassim Ahmed Khan
• Email: mubassimkhan@gmail.com