Skip to content

Latest commit

 

History

History
146 lines (92 loc) · 4.46 KB

README.md

File metadata and controls

146 lines (92 loc) · 4.46 KB

📂 Quick Doc: Intelligent Document Solution

Quick Doc is an intelligent PDF manager built for seamless access, search, and organization of documents. Designed for students, professionals, and anyone juggling multiple PDFs, Quick Doc is your all-in-one solution for managing files across devices.

📥 Download APK

📜 Table of Contents

  1. ✨ Features
  2. 🎯 Benefits
  3. 🎥 Demo Videos
  4. 🚀 Getting Started
  5. How to Contribute
  6. 📄 License

✨ Features

🔍 Smart Search

  • Keyword Search: Quickly locate PDFs with keywords—even vague terms.
  • Advanced NLP: Leverages tokenization and lemmatization for high-accuracy results.

🌐 Cloud and Local Storage

  • Cloud Storage: Securely upload and sync across all devices.
  • Local Access: Manage offline PDFs without an internet connection.

⚡ Real-Time Sync

  • Instant Updates: Edits reflect on all connected devices in real time leveraging the use of Firebase firestore.
  • Cross-Platform: Works seamlessly on Android, iOS, and web.

📂 Easy Organization

  • File Management: Create folders, rename files, and rearrange documents.
  • Color-Coded Files: Distinguish between cloud and local storage visually.

📤 Automatic Import

  • Auto-Detection: Detects PDFs downloaded from messaging apps or browsers.
  • Offline Caching: Cached PDFs for fast access without re-downloading.

🔐 Secure Authentication

  • Email Login: Secure sign-in with Firebase Authentication.

📄 Integrated PDF Viewer

  • In-App Viewing: Open PDFs without external apps.
  • External Viewer: Supports third-party PDF viewers for flexibility.

🎯 Benefits

  • Effortless Search: Save time with precise PDF searches.
  • Device Synchronization: Work seamlessly across all platforms.
  • Offline First: Access files without an internet connection.
  • Secure: Safeguard your documents with encrypted cloud storage.

🎥 Demo Videos

Cloud Storage and Real-Time Sync

📤 Access PDFs from any device with instant synchronization.

cloud_feature_quickdoc.mov

Local Storage Access

📂 Work offline with auto-detected PDFs from local storage.

android_local_quickdoc.mp4

🚀 Getting Started

🔑 Prerequisites

  • Flutter SDK
  • Firebase Account
  • Dart Programming Language

📦 Installation

  1. Clone the repository: 
    git clone https://github.com/chetanr25/quick_docs
cd quick_doc
  2. Install dependencies: 
    flutter pub get
  3. Set up Firebase (instructions below).

🔧 Firebase Setup

Firebase Authentication

  • Navigate to Firebase Console → Authentication → Enable Email/Password Sign-In.

Firebase Storage

  • Navigate to Storage → Configure a storage bucket and set appropriate rules.

Firebase Firestore

  • Navigate to Firestore Database → Create a new database in production/test mode.

Add Config Files

  1. Download google-services.json (for Android) and GoogleService-Info.plist (for iOS).
  2. Place them in their respective directories in the project.

💻 How to Contribute

We welcome contributions! If you'd like to contribute, please refer to our Contributing Guide for detailed instructions on how to report bugs, request features, and submit code.

Thank you for your interest in contributing!

📄 License

This project is licensed under the MIT License.
See the LICENSE file for more details.

Quick Doc is redefining how you manage PDFs. Download now and experience smarter, faster, and more efficient document management! 🚀