# DocVerse

**Repository Path**: hylqb/doc-verse

## Basic Information

- **Project Name**: DocVerse
- **Description**: 基于OnlyOffice的在线文档编辑系统，支持文档在线预览、编辑、协同办公等功能。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-05-26
- **Last Updated**: 2025-05-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OnlyOffice在线文档编辑系统

基于OnlyOffice的在线文档编辑系统，支持文档在线预览、编辑、协同办公等功能。

## 技术栈

### 后端技术
- Spring Boot 3.x
- Java 17+
- MySQL 8.0
- MyBatis-Plus
- Druid
- MinIO
- Redis

### 前端技术
- Vue 3 (Composition API)
- TypeScript
- Element Plus
- Vite
- OnlyOffice Document Server
- OnlyOffice Web SDK

## 项目结构

```text
project-root/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/yourcompany/doceditor/
│   │   │       ├── controller/    # 控制器层
│   │   │       ├── service/       # 业务逻辑层
│   │   │       ├── mapper/        # MyBatis映射层
│   │   │       ├── entity/        # 实体类
│   │   │       ├── config/        # 配置类
│   │   │       └── util/          # 工具类
│   │   └── resources/
│   │       ├── static/            # 前端构建后的静态资源
│   │       ├── templates/         # 模板文件
│   │       └── application.yml    # 配置文件
│   └── frontend/                  # 前端项目目录
│       ├── src/
│       │   ├── components/        # Vue组件
│       │   ├── views/            # 页面视图
│       │   ├── store/            # 状态管理
│       │   ├── api/              # API请求
│       │   └── assets/           # 静态资源
│       ├── package.json
│       └── vite.config.ts
└── pom.xml
```

## 功能模块

### 1. 用户管理
- 用户登录注册
- 权限控制
- 用户信息管理

### 2. 文档管理
- 文档上传下载
- 文档列表管理
- 文档分类管理
- 文档权限控制

### 3. 在线编辑
- 文档预览
- 实时编辑
- 协同编辑
- 版本控制

### 4. 系统管理
- 系统配置
- 日志管理
- 性能监控

## 开发环境要求

- JDK 17+
- Maven 3.8+
- Node.js 16+
- MySQL 8.0
- Redis 6.0+
- Docker (用于部署OnlyOffice Document Server)

## 快速开始

### 1. 环境准备

```bash
# 克隆项目
git clone https://github.com/your-username/doc-editor.git

# 进入项目目录
cd doc-editor

# 安装前端依赖
cd src/frontend
npm install

# 启动OnlyOffice Document Server
docker run -i -t -d -p 80:80 --restart=always onlyoffice/documentserver
```

### 2. 配置修改

1. 修改 `application.yml` 中的数据库配置
2. 修改 MinIO 配置
3. 修改 Redis 配置
4. 修改 OnlyOffice Document Server 地址

### 3. 启动项目

```bash
# 启动后端服务
./mvnw spring-boot:run

# 启动前端开发服务器
cd src/frontend
npm run dev
```

## 部署说明

### 后端部署

1. 使用Maven打包
```bash
./mvnw clean package
```

2. 运行jar包
```bash
java -jar target/doc-editor.jar
```

### 前端部署

1. 构建前端项目
```bash
cd src/frontend
npm run build
```

2. 将dist目录下的文件部署到Web服务器

## 贡献指南

1. Fork 本仓库
2. 创建新的分支 `git checkout -b feature/your-feature`
3. 提交更改 `git commit -m 'Add some feature'`
4. 推送到分支 `git push origin feature/your-feature`
5. 提交 Pull Request

## 许可证

[MIT License](LICENSE)

## 联系方式

- 作者：Your Name
- 邮箱：your.email@example.com

## 致谢

感谢以下开源项目：
- Spring Boot
- Vue.js
- OnlyOffice
- Element Plus
- 等其他开源项目