# 个人仓库2502

**Repository Path**: enterprise2021/personal-warehouse-2502

## Basic Information

- **Project Name**: 个人仓库2502
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-12
- **Last Updated**: 2026-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 个人工作台

面向个人工作与学习的统一管理工具，逐步把**多台电脑上的文件索引、当前与未来任务、学校工作学习成果**集中到一个可检索的工作台。

**技术路线固定为 Vue + Python + SQLite。** 前端使用 Vue 3，后端使用 Python/FastAPI，本机索引和中心数据均使用 SQLite/FTS5；跨设备通过 API 同步数据，不共享数据库文件。

> README 是项目总览和文档入口。产品目标、需求边界和验收标准见 [产品需求文档](docs/PRODUCT_REQUIREMENTS.md)；目标架构、数据模型、接口与安全设计见 [技术设计文档](docs/TECHNICAL_DESIGN.md)。

## 产品目标

项目最终围绕三个相互关联的模块建设：

1. **文件管理**：登记多台电脑上的常用目录，扫描并同步文件元数据，按文件名、路径、扩展名等检索。默认只同步索引信息，原文件保留在所属电脑。
2. **任务管理**：记录现在要做和未来计划做的任务，支持计划日期、截止日期、优先级、状态和提醒。
3. **成果管理**：记录竞赛、项目、专利、论文、软件著作权及其他工作学习成果，并关联任务、文件和证明材料。

## 文档导航

| 文档 | 内容 |
|---|---|
| [产品需求文档](docs/PRODUCT_REQUIREMENTS.md) | 用户场景、功能需求、数据字段、版本范围、验收标准 |
| [技术设计文档](docs/TECHNICAL_DESIGN.md) | 当前架构与目标架构、数据模型、API、同步、安全、部署和演进计划 |

## 当前实现状态

仓库现有代码是一个**单机文件索引与搜索原型**：

- 已实现：目录登记与扫描、文件名/路径搜索、模糊搜索、扩展名和大小筛选、目录浏览、打开本机文件或目录。
- 当前栈：Vue 3、Vite、Element Plus、Axios；Python、FastAPI、Uvicorn；SQLite、FTS5。
- 尚未实现：任务管理、成果管理、账号与多设备同步、中心服务。
- 当前扫描器只访问运行后端的那台电脑。README 和设计文档描述的是完整产品目标，不能视为这些目标功能已经上线。

### 当前版本架构

下图反映仓库现有代码的单机架构，不代表未来多设备目标架构。

![当前版本技术架构图](architecture-16x9.png)

## 快速启动

建议使用 Python 3.9+、Node.js 18+。

在两个终端分别运行：

~~~~powershell
cd backend
pip install -r requirements.txt
python -m uvicorn main:app --host 127.0.0.1 --port 8000 --reload
~~~~

~~~~powershell
cd frontend
npm ci
npm run dev -- --host 127.0.0.1
~~~~

打开 http://127.0.0.1:5173 。前端开发服务器会把 /api 请求代理到 http://127.0.0.1:8000。

- API 文档：http://127.0.0.1:8000/docs
- 健康检查：http://127.0.0.1:8000/api/health

## 当前 API

| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/health | 健康检查 |
| GET | /api/files/search | 按关键词搜索文件，可按扩展名和大小筛选 |
| GET | /api/files/fuzzy | 文件名和路径的模糊搜索 |
| GET | /api/files/extensions | 已索引扩展名统计 |
| GET | /api/files/stats | 索引统计 |
| GET、POST | /api/directories | 查询或添加索引目录 |
| POST | /api/directories/{id}/scan | 重新扫描一个目录 |
| POST | /api/directories/scan-all | 重新扫描全部目录 |
| DELETE | /api/directories/{id} | 删除目录索引，不删除原文件 |
| GET | /api/directories/browse | 浏览本机目录 |
| POST | /api/directories/open | 在本机打开文件或目录 |

## 仓库结构

~~~~text
backend/       FastAPI 服务、扫描器和 SQLite 数据访问
frontend/      Vue 3 单页应用
docs/          产品需求和技术设计
architecture-16x9.png
~~~~

## 设计原则

- 先保证个人数据可检索、可导出、可备份，再逐步增加自动化。
- 多设备文件管理默认传输文件元数据，不自动上传原文件内容。
- 为每条任务和成果保留可追溯的时间、状态和关联材料。
- 将当前已实现能力与计划能力明确区分。

## License

MIT