diff --git a/README.md b/README.md index 42910968..8f42d272 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,4 @@ - - - - +#
NovAnything
@@ -24,295 +6,138 @@ a:hover img[alt="Contributor"] { alt="NovAnything Logo" width="200"> -# NovAnything - -基于QAnything的企业级知识库管理与问答系统 +

+ 基于QAnything的企业级知识库管理与问答系统 +

-[简体中文](./README.md) | [English](./README_en.md) +

+ 简体中文 | + English +

-[![License](https://img.shields.io/badge/license-AGPL--3.0-yellow)](./LICENSE) -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-red)](https://github.com/NovagridAI/NovAnything/pulls) +

+ + License + + + PRs Welcome + +

---- +
-
-📑 目录 +--- -- [✨ 项目简介](#-项目简介) -- [🌟 核心特性](#-核心特性) -- [🔧 系统架构](#-系统架构) -- [📢 版本演进](#-版本演进) -- [🚀 快速开始](#-快速开始) -- [❓ 常见问题](#-常见问题) -- [🤝 参与贡献](#-参与贡献) -- [📄 许可证书](#-许可证书) -- [👥 贡献者](#-贡献者) -- [🙏 致谢](#-致谢) +
- +## ✨ 项目简介 -
+NovAnything 是由 Novagrid 开发的企业级知识库管理与问答系统，基于 [QAnything](https://github.com/netease-youdao/QAnything) 进行二次开发。我们在保留原有系统强大的文档解析和智能问答能力的基础上，增加了用户权限控制和知识库权限管理功能，并对前端界面进行了全面重构优化，使其更适合企业级应用场景。 -# ✨ 项目简介 -
+
-NovAnything 是由 Novagrid 开发的企业级知识库管理与问答系统，基于 [QAnything](https://github.com/netease-youdao/QAnything) 进行二次开发。我们在保留原有系统强大的文档解析和智能问答能力的基础上，增加了用户权限控制和知识库权限管理功能，并对前端界面进行了全面重构优化，使其更适合企业级应用场景。 +---
-
- ## 🌟 核心特性 -
- - -
-

🔐 权限控制

-
-
-

▸ 用户体系

-
    -
  • 三级角色管理
    • -
  • 动态权限继承
    • -
-
-
-

▸ 知识库体系

-
    -
  • 分级控制
    • -
  • 权限转移
    • -
-
-
-
+### 🔐 权限控制 +- **用户体系** + - 三级角色管理 + - 动态权限继承 +- **知识库体系** + - 分级控制 + - 权限转移 + +### 🎨 交互体验 +- **界面设计** + - 响应式布局 + - 更现代的UI +- **交互优化** + - 优化交互逻辑 + - 实时反馈机制 + +### 📄 文档处理 +- **格式支持** + - Office全系 + - PDF/图片 + - 网页/多媒体 +- **智能处理** + - 语义搜索 + - 智能问答 - -
-

🎨 交互体验

-
-
-

▸ 界面设计

-
    -
  • 响应式布局
    • -
  • 更现代的UI
    • -
-
-
-

▸ 交互优化

-
    -
  • 优化交互逻辑
    • -
  • 实时反馈机制
    • -
-
-
-
+
- -
-

📄 文档处理

-
-
-

▸ 格式支持

-
    -
  • Office全系
    • -
  • PDF/图片
    • -
  • 网页/多媒体
    • -
-
-
-

▸ 智能处理

-
    -
  • 语义搜索
    • -
  • 智能问答
    • -
-
-
-
+---
-
- ## 🔧 系统架构 -
- ### 🏗️ 架构演进 -**基于QAnything核心架构，新增权限控制层：** - -
+基于QAnything核心架构，新增权限控制层： -
-
- 🔑 -
-

用户认证系统

-
RBAC 权限模型支持
-
+- 🔑 **用户认证系统** + - RBAC 权限模型支持 +- 🔒 **权限管理模块** + - 部门/角色/用户三级控制 +- 📊 **前端交互优化** + - 更加现代的UI与交互逻辑 -
-
- 🔒 -
-

权限管理模块

-
部门/角色/用户三级控制
-
+### ⚙️ 基础架构 +- QAnything +- Milvus +- MySQL +- ElasticSearch -
-
- 📊 -
-

前端交互优化

-
更加现代的UI与交互逻辑
-
- -
+
-
-
- ⚙️ -
- 基础架构： - QAnything + Milvus + MySQL + ElasticSearch -
-
-
+---
- -
- ## 📢 版本演进 -
- - -
-
-
- ✓ -
-
-

已发布版本 - v0.0.1

- 2025-03-14 -
-
-
    -
  • - 权限管理系统 -
    支持角色/部门/用户三级控制与知识库权限管理
    -
    • -
  • - 前端优化 -
    基于QAnything页面结构进行了UI优化
    -
    • -
-
+### v0.0.1 (2025-03-14) +- **权限管理系统** + - 支持角色/部门/用户三级控制与知识库权限管理 +- **前端优化** + - 基于QAnything页面结构进行了UI优化 - -
-
-
- ⌛ -
-
-

开发进程

- 预计 2025-Q2 完成 -
-
-
-
- 前端重构与优化 - 10% -
-
-
-
-
-
    -
  • - 交互升级 -
    重构大部分的交互逻辑与界面
    -
    • -
-
-
-
-
-
- 后端功能完善 - 15% -
-
-
-
-
-
    -
  • - 模型配置存储 -
    持久化当前用户的配置
    -
    • -
-
+### 开发进程 (预计 2025-Q2) +- **前端重构与优化** (10%) + - 重构大部分的交互逻辑与界面 +- **后端功能完善** (15%) + - 持久化当前用户的配置 -
+
+--- -
+
-# 🚀 快速开始 +## 🚀 快速开始 -## 📋 环境要求 -
+### 📋 环境要求 -| 系统 | 依赖项 | 最低要求 | 说明 | -|-------------|--------------------|--------------|---------------------------------------------------------------------| -| 🐧 Linux | 内存 | ≥20GB | 物理内存或SWAP交换空间 | -| 🍎 macOS | Docker | 20.10.5+ | [安装指南](https://docs.docker.com/engine/install/) | -| 🪟 Windows | Docker Desktop | 4.26.1+ | [安装指南](https://docs.docker.com/desktop/) | -| 🐳 通用 | Docker Compose | 2.23.3+ | [安装指南](https://docs.docker.com/compose/install/) | +| 系统 | 依赖项 | 最低要求 | 说明 | +|------|--------|----------|------| +| 🐧 Linux | 内存 | ≥20GB | 物理内存或SWAP交换空间 | +| 🍎 macOS | Docker | 20.10.5+ | [安装指南](https://docs.docker.com/engine/install/) | +| 🪟 Windows | Docker Desktop | 4.26.1+ | [安装指南](https://docs.docker.com/desktop/) | +| 🐳 通用 | Docker Compose | 2.23.3+ | [安装指南](https://docs.docker.com/compose/install/) | -
+### 📥 安装步骤 - - -## 📥 安装步骤 -
- -### 1️⃣ 获取代码 +1. **获取代码** ```bash git clone https://github.com/NovagridAI/NovAnything.git && cd NovAnything ``` -### 2️⃣ 启动服务 -
- +2. **启动服务** ```bash # Linux 系统 docker compose -f docker-compose-linux.yaml up -d @@ -324,187 +149,95 @@ docker compose -f docker-compose-mac.yaml up -d docker compose -f docker-compose-win.yaml up -d ``` -
+3. **访问入口** +- Web界面：http://localhost:8777/novanything/ +- API服务：http://localhost:8777/api/ -### 3️⃣ 访问入口 -
- -
-
- 🌐 - Web 界面 -
- -
+
-
-
- 🔌 - API 服务 -
- -
+---
-
+## ❓ 常见问题 -# ❓ 常见问题 -
-📚 完整文档请访问 -FAQ文档 -（最近更新：2025-03-15） -
+📚 完整文档请访问 [FAQ文档](docs/FAQ.md)（最近更新：2025-03-15） -
+
-# 🤝 参与贡献 -
+--- -
-
- 💡 - 问题反馈 -
-
提交Bug或功能建议
-
-
- 📖 - 文档改进 -
-
完善使用手册与API文档
-
+## 🤝 参与贡献 -
-
- 💻 - 代码贡献 -
-
提交Pull Request
-
+### 贡献方式 +- 💡 **问题反馈**：提交Bug或功能建议 +- 📖 **文档改进**：完善使用手册与API文档 +- 💻 **代码贡献**：提交Pull Request + +### 联系我们 +- [GitHub Issues](https://github.com/NovagridAI/NovAnything/issues)：问题追踪与功能请求 +- [GitHub Discussions](https://github.com/NovagridAI/NovAnything/discussions)：技术讨论与经验分享 +- 📧 邮箱：contact@novagrid.ai + +
+ +---
-
+## 📄 许可证书 - -
- 📢 -
-
GitHub Issues
-
问题追踪与功能请求
-
-
- +采用 [AGPL-3.0 许可证](./LICENSE) - -
- 💬 -
-
GitHub Discussions
-
技术讨论与经验分享
-
-
- +
-
-
- 📧 -
-
联系邮箱
- contact@novagrid.ai -
-
-
+---
-
- -# 📄 许可证书 -
-
- ⚖️ -
- 采用 AGPL-3.0 许可证 -
开源自由，共同成长
-
-
-
+## 👥 贡献者 + +### 🌟 核心贡献者 -
- -# 👥 贡献者 - -## 🌟 核心贡献者 -
- - - -
-
- Contributor -
-
Mangosata
-
@Mangosata
-
-
-
+ + + + + +
+ +Mangosata +
+Mangosata - -
-
- Contributor -
-
Shrimp
-
@Sshrimp
-
-
-
+		 + +Shrimp +
+Shrimp +
- +
-
+--- - - -
- -# 🙏 致谢 - -
+## 🙏 致谢 + +特别鸣谢： +- [QAnything](https://github.com/netease-youdao/QAnything) -
-

由 Novagrid 倾力打造

-

Copyright © 2025 Novagrid AI. All rights reserved.

+
+ +--- + +
+ +
+

由 Novagrid 倾力打造

+

Copyright © 2025 Novagrid AI. All rights reserved.

diff --git a/README_en.md b/README_en.md index 15cdd490..a11e86d0 100644 --- a/README_en.md +++ b/README_en.md @@ -1,388 +1,143 @@ - - - -
+
NovAnything Logo + width="200"> -

NovAnything

-

Enterprise-level knowledge base management and question-answering system based on QAnything

+

+ Enterprise-level knowledge base management and question-answering system based on QAnything +

- +

+ 简体中文 | + English +

- - -
- -
- -
- -

- 📑 Table of Contents

- - - - -
- -
- - - - - - - - - +

- -
- ❓ FAQ -
+
- +--- - - +## ✨ Project Introduction - +NovAnything is an enterprise-level knowledge base management and question-answering system developed by Novagrid, based on secondary development of [QAnything](https://github.com/netease-youdao/QAnything). While retaining the original system's robust document parsing and intelligent question-answering capabilities, we have added user access control and knowledge base permission management features. Additionally, the front-end interface has been completely redesigned and optimized to better suit enterprise application scenarios. - +
-
+---
-
- -
-# ✨ Project Introduction -
- -NovAnything is an enterprise-level knowledge base management and question-answering system developed by Novagrid, based on secondary development of [QAnything](https://github.com/netease-youdao/QAnything). While retaining the original system's robust document parsing and intelligent question-answering capabilities, we have added user access control and knowledge base permission management features. Additionally, the front-end interface has been completely redesigned and optimized to better suit enterprise application scenarios. - -
+## 🌟 Core Features -
+### 🔐 Access Control +- **User System** + - Three-tier role management + - Dynamic permission inheritance +- **Knowledge Base System** + - Hierarchical control + - Permission transfer -## 🌟 Core Features -
- -
- - -
-

🔐 Access Control

-
-
-

▸ User

-
    -
  • Three-tier role management
    • -
  • Dynamic permission inheritance
    • -
-
-
-

▸ RAG

-
    -
  • Hierarchical control
    • -
  • Permission transfer
    • -
-
-
-
+### 🎨 User Experience +- **Interface Design** + - Responsive layout + - More modern UI +- **Interaction Optimization** + - Optimize interaction logic + - Real-time feedback - -
-

🎨 User Experience

-
-
-

▸ Interface

-
    -
  • Responsive layout
    • -
  • More modern UI
    • -
-
-
-

▸ Interactive

-
    -
  • Optimize interaction logic
    • -
  • Real-time feedback
    • -
-
-
-
+### 📄 Document Process +- **Format Support** + - All Office suites + - PDF/Picture + - Web/Multimedia +- **Intelligent Process** + - Semantic search + - Intelligent Q&A - -
-

📄 Document Process

-
-
-

▸ Format Support

-
    -
  • All Office suites
    • -
  • PDF/Picture
    • -
  • Web/Multimedia
    • -
-
-
-

▸ Intelligent Process

-
    -
  • Semantic search
    • -
  • Intelligent Q&A
    • -
-
-
-
+
-
+---
-
- ## 🔧 System Architecture -
### 🏗️ Version Evolution **Based on QAnything's core architecture, with added access control layer:** -
+- 🔑 **User Authentication System** + - RBAC Permission Model Support +- 🔒 **Permission Management Module** + - Department/Role/User Three-level Control +- 📊 **Frontend Interaction Optimization** + - More Modern UI and Interaction Logic -
-
- 🔑 -
-

User Authentication System

-
RBAC Permission Model Support
-
+### ⚙️ Base Architecture +- QAnything +- Milvus +- MySQL +- ElasticSearch -
-
- 🔒 -
-

Permission Management Module

-
Department/Role/User Three-level Control
-
+
-
-
- 📊 -
-

Frontend Interaction Optimization

-
More Modern UI and Interaction Logic
-
+---
-
-
- ⚙️ -
- Base Architecture: - QAnything + Milvus + MySQL + ElasticSearch -
-
-
+## 📢 Version Evolution -
+### v0.0.1 (2025-03-14) +- **Permission Management System** + - Support for role/department/user three-level control and knowledge base permission management +- **Frontend Optimization** + - UI optimization based on QAnything's page structure +### Development Progress (Expected 2025-Q2) +- **Frontend Refactoring and Optimization** (10%) + - Refactoring most of the interaction logic and interface +- **Backend Function Enhancement** (15%) + - Persistent storage of current user configurations -
- -## �� Version Evolution -
- - -
-
-
- ✓ -
-
-

Released Version - v0.0.1

- 2025-03-14 -
-
-
    -
  • - Permission Management System -
    Support for role/department/user three-level control and knowledge base permission management
    -
    • -
  • - Frontend Optimization -
    UI optimization based on QAnything's page structure
    -
    • -
-
+
- -
-
-
- ⌛ -
-
-

Development Progress

- Expected completion: 2025-Q2 -
-
-
-
- Frontend Refactoring and Optimization - 10% -
-
-
-
-
-
    -
  • - Interaction Upgrade -
    Refactoring most of the interaction logic and interface
    -
    • -
-
-
-
-
-
- Backend Function Enhancement - 15% -
-
-
-
-
-
    -
  • - Model Configuration Storage -
    Persistent storage of current user configurations
    -
    • -
-
+---
+## 🚀 Quick Start -
- -# 📢 Quick Start -
- -## 📋 Environment Requirements -
+### 📋 Environment Requirements -| System | Dependency | Minimum Requirement | Description | -|-------------|--------------------|---------------------|-----------------------------------------------------------------------| -| 🐧 Linux | Memory | ≥20GB | Physical memory or SWAP space | -| 🍎 macOS | Docker | 20.10.5+ | [Installation Guide](https://docs.docker.com/engine/install/) | -| 🪟 Windows | Docker Desktop | 4.26.1+ | [Installation Guide](https://docs.docker.com/desktop/) | -| 🐳 General | Docker Compose | 2.23.3+ | [Installation Guide](https://docs.docker.com/compose/install/) | +| System | Dependency | Minimum Requirement | Description | +|--------|------------|---------------------|-------------| +| 🐧 Linux | Memory | ≥20GB | Physical memory or SWAP space | +| 🍎 macOS | Docker | 20.10.5+ | [Installation Guide](https://docs.docker.com/engine/install/) | +| 🪟 Windows | Docker Desktop | 4.26.1+ | [Installation Guide](https://docs.docker.com/desktop/) | +| 🐳 General | Docker Compose | 2.23.3+ | [Installation Guide](https://docs.docker.com/compose/install/) | -
+### 📥 Installation Steps - - -## 📥 Installation Steps -
- -### 1️⃣ Get the Code +1. **Get the Code** ```bash git clone https://github.com/NovagridAI/NovAnything.git && cd NovAnything ``` -### 2️⃣ Start Services -
- +2. **Start Services** ```bash # Linux System docker compose -f docker-compose-linux.yaml up -d @@ -394,187 +149,96 @@ docker compose -f docker-compose-mac.yaml up -d docker compose -f docker-compose-win.yaml up -d ``` -
+3. **Access** +- Web Interface: http://localhost:8777/novanything/ +- API Service: http://localhost:8777/api/ -### 3️⃣ Access -
- -
-
- 🌐 - Web Interface -
- -
+
-
-
- 🔌 - API Service -
- -
+---
-
+## ❓ FAQ -# ❓ FAQ -
-📚 Complete documentation available at -FAQ Documentation -（Last updated: 2025-03-15） -
+📚 Complete documentation available at [FAQ Documentation](docs/FAQ.md) (Last updated: 2025-03-15) -
+
-# 🤝 Contribution Guide -
+--- -
-
- 💡 - Issue Reporting -
-
Submit bugs or feature suggestions
-
-
- 📖 - Documentation Improvement -
-
Enhance user manual and API documentation
-
+## 🤝 Contribution Guide -
-
- 💻 - Code Contribution -
-
Submit Pull Requests
-
+### Contribution Methods +- 💡 **Issue Reporting**: Submit bugs or feature suggestions +- 📖 **Documentation Improvement**: Enhance user manual and API documentation +- 💻 **Code Contribution**: Submit Pull Requests + +### Contact Us +- [GitHub Issues](https://github.com/NovagridAI/NovAnything/issues): Issue tracking and feature requests +- [GitHub Discussions](https://github.com/NovagridAI/NovAnything/discussions): Technical discussions and experience sharing +- 📧 Email: contact@novagrid.ai + +
+ +---
-
+## 📄 License - -
- 📢 -
-
GitHub Issues
-
Issue tracking and feature requests
-
-
- +Licensed under [AGPL-3.0 License](./LICENSE) - -
- 💬 -
-
GitHub Discussions
-
Technical discussions and experience sharing
-
-
- +
-
-
- 📧 -
-
Contact Email
- contact@novagrid.ai -
-
-
+---
-
- -# 📄 License -
-
- ⚖️ -
- Licensed under AGPL-3.0 License -
Open source, grow together
-
-
-
+## 👥 Contributors + +### 🌟 Core Contributors -
- -# 👥 Contributors -
- -## 🌟 Core Contributors - +
+ +--- - - -
- -# 🙏 Acknowledgments - -
+## 🙏 Acknowledgments + +Special Thanks: +- [QAnything](https://github.com/netease-youdao/QAnything) + +
+ +--- + +
-
-

Crafted with ❤️ by Novagrid

-

Copyright © 2025 Novagrid AI. All rights reserved.

+
+

Crafted with ❤️ by Novagrid

+

Copyright © 2025 Novagrid AI. All rights reserved.