# 文档协同编辑系统

**Repository Path**: qtfy2020/HappySheet

## Basic Information

- **Project Name**: 文档协同编辑系统
- **Description**: 基于LuckSheet开发的文档协同编辑系统，包含nodeJs后台
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2026-03-25
- **Last Updated**: 2026-03-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档协同编辑系统

#### 介绍
基于LuckySheet开发的文档协同编辑系统，包含nodeJs后台
该项目的使用场景是在任意系统中嵌入，url中传参文件地址、文件名称、文件id、用户id、用户名称 便可以协同编辑该文件
项目启动后，使用测试地址就可以开始体验
测试地址有2个，使用项目中的xlsx文件进行测试，editUser分别为 张三 和 李四
1. https://localhost:9999/?editUser=张三&userId=001&fileId=123&fileName=测试.xlsx&readOnly=false&fileUrl=https://localhost:9999/test/demo.xlsx
2. https://localhost:9999/?editUser=李四&userId=002&fileId=123&fileName=测试.xlsx&readOnly=false&fileUrl=https://localhost:9999/test/demo.xlsx
![图片描述](demoImages/image01.png)
![图片描述](demoImages/image02.png)

您编辑的excel文件的json数据会自动缓存在服务端静态目录“server/src/static_excel_json”下，如果想把附件更新到你自己的服务器下，请到app.vue下的handleUpdate方法中自定义实现上传。

#### 参数说明
| 参数 | 说明 | 类型 |
|-------|-------|-------|
| editUser | 编辑人姓名 | string |
| userId | 编辑人Id | string |
| fileId | 文件ID | string |
| fileName | 文件名称 | string |
| fileUrl | 文件路径 | string |
| readOnly | 是否只读 | string |

#### 软件架构
软件架构说明
```
project-name/
├── certs 测试环境证书，因为项目需要https
├── client 前端
├── server 服务端
├── package.json
└── README.md
```




#### 安装教程

1.  根目录下执行 npm install，下载同可以支持同时启动客户端和服务端的依赖
2.  在client目录下执行 npm install，下载同可以支持启动客户端的依赖
3.  在server目录下执行 npm install，下载同可以支持启动服务端的依赖

#### 使用说明
1.  在根目录下执行 npm run start，启动客户端和服务端


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request