collabdocchat 2.4.9 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,19 +1,46 @@
1
- # CollabDocChat v1.4.0 - 协作文档聊天系统
1
+ # CollabDocChat v2.4.9 - 协作文档聊天系统
2
2
 
3
3
  <div align="center">
4
4
 
5
- ![Version](https://img.shields.io/badge/version-1.4.0-blue.svg)
6
- ![Status](https://img.shields.io/badge/status-85%25%20complete-green.svg)
5
+ ![Version](https://img.shields.io/badge/version-2.4.9-blue.svg)
6
+ [![npm](https://img.shields.io/npm/v/collabdocchat.svg)](https://www.npmjs.com/package/collabdocchat)
7
+ [![npm downloads](https://img.shields.io/npm/dm/collabdocchat.svg)](https://www.npmjs.com/package/collabdocchat)
7
8
  ![License](https://img.shields.io/badge/license-MIT-blue.svg)
8
9
 
9
10
  一个功能丰富的实时协作平台,集成了群组管理、文档协作、任务管理、实时聊天、AI助手等功能。
10
11
 
11
- [功能特性](#-功能特性) • [快速开始](#-快速开始) • [演示指南](#-功能演示) • [文档](#-文档)
12
+ [快速开始](#-最简单的使用方式) • [功能特性](#-功能特性) • [完整安装](#-完整安装开发模式) • [文档](#-文档)
12
13
 
13
14
  </div>
14
15
 
15
16
  ---
16
17
 
18
+ ## 🚀 最简单的使用方式
19
+
20
+ ### 一键安装和启动
21
+
22
+ ```bash
23
+ # 安装
24
+ npm install -g collabdocchat
25
+
26
+ # 启动
27
+ collabdocchat
28
+ ```
29
+
30
+ 就这么简单!浏览器会自动打开。
31
+
32
+ **默认账号**: admin / admin123
33
+
34
+ ### 或者使用一键脚本
35
+
36
+ **Windows**: 双击运行 `one-click-start.bat`
37
+ **Linux/Mac**: 运行 `./one-click-start.sh`
38
+
39
+ > 📝 **前提条件**: 需要先安装 [Node.js](https://nodejs.org/) 和 [MongoDB](https://www.mongodb.com/try/download/community)
40
+ > 📖 **详细指南**: 查看 [USER_GUIDE.md](./USER_GUIDE.md)
41
+
42
+ ---
43
+
17
44
  ## ✨ 功能特性
18
45
 
19
46
  ### 🎯 核心功能(100% 完成)
@@ -83,12 +110,14 @@
83
110
 
84
111
  ---
85
112
 
86
- ## 🚀 快速开始
113
+ ## 🚀 完整安装(开发模式)
114
+
115
+ 如需完整的前端界面和开发环境:
87
116
 
88
117
  ### 环境要求
89
- - Node.js >= 14.0.0
118
+ - Node.js >= 16.0.0
90
119
  - MongoDB >= 4.0
91
- - npm >= 6.0.0
120
+ - npm >= 7.0.0
92
121
 
93
122
  ### 1. 克隆项目
94
123
  ```bash
@@ -128,7 +157,7 @@ npm start
128
157
  ```
129
158
 
130
159
  ### 6. 访问应用
131
- - **前端**: http://localhost:5174
160
+ - **前端**: http://localhost:5173
132
161
  - **后端**: http://localhost:8765
133
162
 
134
163
  ### 7. 默认账号
@@ -137,6 +166,32 @@ npm start
137
166
 
138
167
  ---
139
168
 
169
+ ## 📦 NPM 包使用
170
+
171
+ ### 全局安装(API 服务器模式)
172
+
173
+ ```bash
174
+ npm install -g collabdocchat
175
+ collabdocchat
176
+ ```
177
+
178
+ **特点**:
179
+ - ✅ 快速启动 API 服务器
180
+ - ✅ 自动打开浏览器显示欢迎页面
181
+ - ✅ 提供完整的 RESTful API
182
+ - ⚠️ 无前端开发界面
183
+
184
+ **访问**: http://localhost:3000
185
+
186
+ ### 本地安装(项目集成)
187
+
188
+ ```bash
189
+ npm install collabdocchat
190
+ npx collabdocchat
191
+ ```
192
+
193
+ ---
194
+
140
195
  ## 📁 项目结构
141
196
 
142
197
  ```
@@ -189,20 +244,33 @@ CollabDocChat/
189
244
  ## 📚 文档
190
245
 
191
246
  ### 用户文档
192
- - [演示指南](./DEMO_GUIDE.md) - 详细的功能演示
193
- - [快速开始](./QUICK_START_V1.3.md) - 快速上手指南
247
+ - [用户快速上手指南](./USER_GUIDE.md) - **推荐新用户阅读**
248
+ - [全局安装修复指南](./GLOBAL_INSTALL_FIX.md) - 全局安装问题解决
249
+ - [快速使用指南](./QUICK_USE_GUIDE.md) - 快速使用说明
194
250
 
195
251
  ### 开发文档
252
+ - [NPM 发布指南](./NPM_PUBLISH_GUIDE.md) - NPM 发布流程
253
+ - [版本清理指南](./NPM_VERSION_CLEANUP_GUIDE.md) - 版本管理
254
+ - [启动问题修复](./STARTUP_FIX_GUIDE.md) - 启动问题解决
255
+
256
+ ### 项目文档
196
257
  - [功能集成指南](./FEATURES_INTEGRATION_GUIDE.md) - 功能集成说明
197
258
  - [实现状态](./IMPLEMENTATION_STATUS.md) - 功能实现状态
198
- - [当前状态](./CURRENT_STATUS.md) - 项目当前状态
199
- - [完成总结](./COMPLETION_SUMMARY.md) - 功能完成总结
259
+ - [更新日志](./CHANGELOG.md) - 完整更新日志
200
260
 
201
261
  ---
202
262
 
203
263
  ## 📝 更新日志
204
264
 
205
- ### v1.4.0 (2026-01-26) - 当前版本
265
+ ### v2.4.9 (2026-02-03) - 最新版本
266
+ - ✅ 添加全局安装欢迎页面
267
+ - ✅ 自动打开浏览器功能
268
+ - ✅ 修复全局安装自动依赖问题
269
+ - ✅ 修复 Windows spawn 错误
270
+ - ✅ 清理 41 个临时开发脚本
271
+ - ✅ 优化包体积(减少 5%)
272
+
273
+ ### v1.4.0 (2026-01-26)
206
274
  - ✅ 添加主题定制系统(8个预设主题 + 自定义)
207
275
  - ✅ 添加AI助手系统(6大功能)
208
276
  - ✅ 添加权限细化管理
@@ -218,21 +286,31 @@ CollabDocChat/
218
286
 
219
287
  ## ❓ 常见问题
220
288
 
289
+ ### Q: 如何快速开始使用?
290
+ **A**: 运行 `npm install -g collabdocchat && collabdocchat`,就这么简单!
291
+
292
+ ### Q: 需要安装什么?
293
+ **A**: 只需要 Node.js (>= 16.0.0) 和 MongoDB (>= 4.0)。详见 [USER_GUIDE.md](./USER_GUIDE.md)
294
+
295
+ ### Q: 全局安装和完整安装有什么区别?
296
+ **A**:
297
+ - **全局安装**: 只有 API 服务器,适合快速测试
298
+ - **完整安装**: 包含前端界面,适合开发和完整使用
299
+
221
300
  ### Q: 无法连接数据库?
222
301
  **A**: 确保MongoDB服务已启动,并检查`.env`中的连接字符串。
223
302
 
224
303
  ### Q: WebSocket连接失败?
225
- **A**: 检查防火墙设置,确保端口8765未被占用。
304
+ **A**: 检查防火墙设置,确保端口未被占用。
226
305
 
227
- ### Q: AI助手返回的结果不准确?
228
- **A**: 当前AI功能为模拟实现,接入真实AI API后会提供准确结果。
306
+ ### Q: 如何更新到最新版本?
307
+ **A**: 运行 `npm update -g collabdocchat`
229
308
 
230
- ### Q: 如何重新触发新手引导?
231
- **A**: 在浏览器控制台执行:
232
- ```javascript
233
- localStorage.removeItem('onboardingCompleted');
234
- location.reload();
235
- ```
309
+ ### Q: 如何获取帮助?
310
+ **A**:
311
+ - 查看 [USER_GUIDE.md](./USER_GUIDE.md)
312
+ - 提交 [Issue](https://github.com/shijinghao/collabdocchat/issues)
313
+ - 访问 [NPM 页面](https://www.npmjs.com/package/collabdocchat)
236
314
 
237
315
  ---
238
316
 
@@ -298,6 +376,8 @@ location.reload();
298
376
 
299
377
  Made with ❤️ by CollabDocChat Team
300
378
 
301
- **版本**: v1.4.0 | **更新日期**: 2026-01-26 | **完成度**: 85%
379
+ **版本**: v2.4.9 | **NPM**: [collabdocchat](https://www.npmjs.com/package/collabdocchat) | **许可证**: MIT
380
+
381
+ [GitHub](https://github.com/shijinghao/collabdocchat) • [NPM](https://www.npmjs.com/package/collabdocchat) • [Issues](https://github.com/shijinghao/collabdocchat/issues)
302
382
 
303
383
  </div>