AskFiles (文档问答助手) 🚀

AskFiles 是一个功能强大、美观且智能的文档问答及知识库管理系统。它结合了先进的大语言模型（LLM）与增强检索生成（RAG）技术，允许用户高效地从各种格式的文档中提取信息并进行深度对话。

---

✨ 核心特性

• 多格式支持: 支持 PDF、Word (.docx)、纯文本 (.txt) 以及 图像 (OCR) 的内容提取与分析。
• 智能对话助手: 内置多种 LLM 模型支持（如 Gemini, GLM-5 等），提供精准的文档问答体验。
• 知识库管理: 简单直观的文件上传与管理系统，支持多端同步（Supabase 驱动）。
• 实时文档预览: 集成的 PDF 渲染器与文本预览器，在对话时即可查阅原始出处。
• OCR 增强: 通过 PaddleOCR 的集成，能够精准识别扫描件与图像中的文字内容。
• 极致视觉体验: 基于 Next.js 15 和现代 UI 框架构建，支持暗黑模式、丝滑动画（Framer Motion）。

---

🛠️ 技术栈

前端 (Frontend)

• Framework: Next.js 15 (App Router)
• Styling: Tailwind CSS 4
• State Management: React Hooks & Context API
• Animations: Motion (Framer Motion)
• Icons: Lucide React
• Markdown: React Markdown + KaTeX (数学公式支持)

后端 (Backend)

• Language: Python 3.11
• Framework: FastAPI
• Database/Auth: Supabase
• Extraction: python-docx for Word, PaddleOCR for Image/Scan OCR
• Environment Management: Conda / Pip

---

🚀 本地启动指南

前期准备

确保你已安装以下环境：

• Node.js (v18+)
• Python 3.11
• Conda (可选，推荐)

1. 克隆仓库

git clone https://github.com/CRonaldo1997/AskFiles.git
cd AskFiles

2. 后端启动

cd backend
# 建议创建 conda 环境
conda create -n py311 python=3.11
conda activate py311
# 安装依赖
pip install -r requirements.txt
# 配置环境变量 (参考 .env.example)
# 启动服务
python -m uvicorn app.main:app --reload --port 8000

3. 前端启动

cd frontend
# 安装依赖
npm install
# 配置环境变量
# 启动开发服务器
npm run dev

访问 http://localhost:3000 即可开始体验。

---

⚙️ 环境变量配置

请在 backend 和 frontend 目录下分别创建 .env 文件，并填写必要的配置：

Backend (backend/.env):

SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key
PADDLE_OCR_TOKEN=your_paddle_ocr_token

Frontend (frontend/.env):

NEXT_PUBLIC_API_URL=http://localhost:8000

---

📸 界面预览

(你可以将系统截图放置于此处)

🌐 部署指南 (Deployment)

本项目推荐采用 前后端分离部署 的模式：

1. 后端 (Render)

• 平台: Render.com (Web Service)
• Root Directory: backend
• Build Command: pip install -r requirements.txt
• Start Command: gunicorn app.main:app -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:$PORT
• 环境变量:
  • SUPABASE_URL: 你的 Supabase 项目 URL
  • SUPABASE_KEY: 你的 Supabase Service Role Key (或 Anon Key)
  • PADDLE_OCR_TOKEN: 你的 OCR API 访问令牌

2. 前端 (Vercel)

• 平台: Vercel
• Root Directory: frontend
• Framework Preset: Next.js
• 环境变量:
  • NEXT_PUBLIC_API_URL: 你在 Render 部署后的后端地址 (如 https://xxx.onrender.com)

3. 数据库 (Supabase)

请确保在 Supabase 中创建了以下表：

• documents: 存储文件元数据、状态及解析后的 OCR 内容。
• chats: 存储对话历史。

---

📄 开源协议

本项目采用 MIT License 开源。