Quick Docs

Quick Docs is a modern document management and text extraction application built with Flutter and FastAPI, featuring cloud storage integration with Azure Blob Storage and Firebase.

Table of Contents

• Overview
• Features
• Architecture
• Tech Stack

• Contributing
• License

Overview

Quick Docs is a comprehensive document management system that allows users to upload, process, and organize their documents efficiently. It features text extraction, document organization with folders, and secure cloud storage integration.

Features

Document Management

• 📁 Folder organization
• 📄 Document upload and processing
• 🔍 Full-text search capability
• 📱 Mobile-friendly interface
• 📂 Hierarchical folder structure
• 🏷️ Document tagging and categorization

File Processing

• 📝 Text extraction from multiple file formats
• 💾 Supported formats: PDF, TXT, DOCX, DOC
• 🔄 Background processing for large files
• 📊 Document statistics and analysis

Storage & Security

• ☁️ Azure Blob Storage integration
• 🔒 Secure file storage
• 🚀 Firebase integration
• 💽 Local caching for better performance

User Interface

• 🌙 Dark mode support
• 📱 Responsive design
• 🎨 Modern Material Design
• ⚡ Fast and intuitive navigation

Tech Stack

App

• Flutter SDK
• Firebase Auth
• Cloud Firestore
• Azure Storage SDK
• Material Design

Backend (FastAPI)

• FastAPI framework
• Azure Blob Storage
• Python 3.8+

Cloud Services

• Azure Blob Storage
• Firebase Authentication
• Cloud Firestore
• Firebase Cloud Storage

Getting Started(getting-started)

Installation

1. Clone the repository:

git clone https://github.com/chetanr25/quick-docs.git
cd quick-docs

2. Install backend dependencies:

cd backend_api
pip install -r requirements.txt

3. Install flutter dependencies:

cd quick_doc_app
flutter pub get

Configuration

1. Backend Environment Variables:

View .env.example

AZURE_STORAGE_ACCOUNT_URL=your_storage_account_url
AZURE_STORAGE_CONTAINER_NAME=your_container_name
ALLOWED_HOSTS=*

2. Frontend Environment Variables: Create a .env file in the quick_doc_app directory:

API_BASE_URL=http://localhost:8000

Project Structure

The project follows a standard file structure for both app and backend components, ensuring maintainability and scalability:

Frontend Structure

quick_doc_app/
├── lib/
│   ├── core/           # Core utilities and constants
│   ├── models/         # Data models
│   ├── screens/        # UI screens
│   ├── services/       # Business logic and API services
│   ├── theme/          # App theme and styling
│   ├── utils/          # Utility functions
│   └── widgets/        # Reusable widgets

Backend Structure

backend_api/
├── app/
│   ├── api/           # API endpoints
│   ├── core/          # Core configurations
│   ├── models/        # Data models
│   ├── services/      # Business logic
│   └── utils/         # Utility functions

Development Guide

Running the Backend

cd backend_api
uvicorn main:app --reload

Running the app (Recommended to use physical devices instead of emulators)

cd quick_doc_app
flutter run

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.