# document-manage

**Repository Path**: qiaoyn/document-manage

## Basic Information

- **Project Name**: document-manage
- **Description**: 基于 Next.js 的现代化文档管理系统，支持 Markdown 和纯文本文件的上传、查看与管理。系统提供 Web 版本和 Electron 桌面版本（位于 electron 分支），具备文档自动标题提取、全文搜索、Markdown 渲染以及 AI 辅助功能（如摘要生成和翻译）。采用 PostgreSQL 数据库存储数据，使用 TypeScript 和 Tailwind CSS 构建，支
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-19
- **Last Updated**: 2025-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档管理系统

这是一个基于 Next.js 的文档管理系统，支持 Markdown 和纯文本文件的上传、查看和管理。

## 🖥️ 桌面版本

该项目还提供了 Electron 桌面版本，代码位于 `electron` 分支。桌面版本具有以下优势：

要获取桌面版本，请切换到 `electron` 分支：
```bash
git checkout electron
```

## 功能特点

- 上传 Markdown 和纯文本文件
- 自动提取文档标题
- 文档列表展示和搜索
- 文档内容预览（支持 Markdown 渲染）
- AI 辅助功能（文档摘要、翻译等）

## 技术栈

- Next.js 16
- React 19
- TypeScript
- Tailwind CSS
- PostgreSQL (数据库存储)
- OpenAI SDK (AI 功能)

## 快速开始

1. 安装依赖:
```bash
npm install
```

2. 设置数据库:
```bash
# 创建 PostgreSQL 数据库
createdb document_db

# 执行初始化脚本 (init-db.sql)
psql -d document_db -f init-db.sql
```

3. 配置环境变量:
```bash
cp .env.example .env
# 编辑 .env 文件，填写正确的数据库连接信息和其他服务密钥
```

4. 启动开发服务器:
```bash
npm run dev
```

5. 访问应用:
打开浏览器访问 http://localhost:3000

## 数据库存储

文档现在存储在 PostgreSQL 数据库中，替代了原来的 localStorage 存储方案。

### 数据库表结构

```sql
CREATE TABLE documents (
    id SERIAL PRIMARY KEY,
    title VARCHAR(255) NOT NULL,
    file_name VARCHAR(255) NOT NULL,
    content TEXT NOT NULL,
    upload_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
```

### 环境变量配置

确保在 `.env` 文件中正确配置了数据库连接:

```
DATABASE_URL=postgresql://username:password@localhost:5432/document_db
```

您还可以配置 AI 相关的服务密钥来启用额外功能：
- BAIDU_APP_ID 和 BAIDU_SECRET_KEY 用于百度翻译
- MODELSCOPE_API_KEY 用于 ModelScope AI 服务

## 部署

构建生产版本:
```bash
npm run build
```

启动生产服务器:
```bash
npm start
```

## Electron 桌面版本

如需使用桌面版本，请切换到 `electron` 分支：
```bash
git checkout electron
```

然后按照该分支中的说明进行构建和运行。