collabdocchat 1.2.2 → 1.2.4

package/README.md

@@ -0,0 +1,262 @@
+# CollabDocChat 📝💬
+
+[![npm version](https://img.shields.io/npm/v/collabdocchat.svg)](https://www.npmjs.com/package/collabdocchat)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D16.0.0-brightgreen.svg)](https://nodejs.org/)
+
+> 🚀 开源的实时协作文档聊天平台 - 集成任务管理、多人文档编辑、智能点名功能
+
+一个功能强大的实时协作平台，支持多人同时编辑文档、实时聊天、任务管理和团队协作。基于 Yjs CRDT 算法实现的无冲突协同编辑，让团队协作更加高效。
+
+## ✨ 核心特性
+
+- 🔄 **实时协作编辑** - 基于 Yjs CRDT 算法，支持多人同时编辑，自动解决冲突
+- 💬 **即时通讯** - WebSocket 实时聊天，支持 @提及、智能点名
+- 📋 **任务管理** - 创建、分配、跟踪任务，提升团队效率
+- 👥 **团队协作** - 群组管理、权限控制、成员管理
+- 📁 **文件管理** - 文件上传、下载、版本控制
+- 🔐 **安全可靠** - JWT 认证、权限管理、审计日志
+- 🎨 **现代化 UI** - 响应式设计，支持深色模式
+- 📊 **管理后台** - 完整的管理员控制面板
+
+## 🚀 快速开始
+
+### 方式一：使用 npx (推荐)
+
+```bash
+npx collabdocchat
+```
+
+### 方式二：全局安装
+
+```bash
+# 全局安装
+npm install -g collabdocchat
+
+# 启动应用
+collabdocchat
+```
+
+### 方式三：项目中使用
+
+```bash
+# 安装到项目
+npm install collabdocchat
+
+# 启动
+npm start
+```
+
+## 📋 系统要求
+
+- **Node.js**: >= 16.0.0
+- **npm**: >= 7.0.0
+- **MongoDB**: >= 4.4 (需要单独安装)
+
+## 🔧 配置说明
+
+首次运行时，系统会自动创建配置文件。您也可以手动创建 `.env` 文件：
+
+```env
+# 服务器配置
+PORT=3000
+NODE_ENV=development
+
+# MongoDB 配置
+MONGODB_URI=mongodb://localhost:27017/collabdocchat
+
+# JWT 配置
+JWT_SECRET=your-secret-key-here
+JWT_EXPIRES_IN=7d
+
+# 管理员账号（首次启动时创建）
+ADMIN_USERNAME=admin
+ADMIN_PASSWORD=admin123
+ADMIN_EMAIL=admin@example.com
+```
+
+## 📖 使用指南
+
+### 1. 启动应用
+
+```bash
+# 开发模式（自动重启）
+npm run dev
+
+# 生产模式
+npm start
+
+# 快速启动（自动配置）
+npm run quick-start
+
+# 停止应用
+npm run stop
+```
+
+### 2. 访问应用
+
+启动成功后，浏览器会自动打开：
+- **应用地址**: http://localhost:3000
+- **默认管理员账号**: admin / admin123
+
+### 3. 主要功能
+
+#### 📝 文档协作
+- 创建新文档或加入现有文档
+- 实时查看其他用户的光标位置
+- 支持富文本编辑（粗体、斜体、列表等）
+- 自动保存，无需担心数据丢失
+
+#### 💬 实时聊天
+- 在文档中实时交流
+- @提及特定用户
+- 智能点名功能
+- 消息历史记录
+
+#### 📋 任务管理
+- 创建任务并分配给团队成员
+- 设置优先级和截止日期
+- 跟踪任务状态（待办、进行中、已完成）
+- 任务评论和讨论
+
+#### 👥 团队管理
+- 创建和管理群组
+- 邀请成员加入
+- 设置成员权限（管理员、成员）
+- 查看团队活动
+
+## 🏗️ 技术栈
+
+### 后端
+- **Node.js** + **Express** - 服务器框架
+- **MongoDB** + **Mongoose** - 数据库
+- **WebSocket** (ws) - 实时通信
+- **JWT** - 身份认证
+- **Yjs** - CRDT 协同编辑
+
+### 前端
+- **Vanilla JavaScript** - 轻量级前端
+- **Quill** - 富文本编辑器
+- **Vite** - 构建工具
+- **CSS3** - 现代化样式
+
+## 📁 项目结构
+
+```
+collabdocchat/
+├── bin/                    # CLI 入口
+│   └── cli.js
+├── server/                 # 后端代码
+│   ├── models/            # 数据模型
+│   ├── routes/            # API 路由
+│   ├── middleware/        # 中间件
+│   ├── utils/             # 工具函数
+│   ├── websocket/         # WebSocket 处理
+│   └── index.js           # 服务器入口
+├── src/                   # 前端代码
+│   ├── pages/            # 页面组件
+│   ├── services/         # API 服务
+│   └── styles/           # 样式文件
+├── scripts/              # 脚本工具
+│   ├── postinstall.js   # 安装后脚本
+│   ├── start-app.js     # 启动脚本
+│   └── quick-start.js   # 快速启动
+└── package.json
+```
+
+## 🔐 安全特性
+
+- **JWT 认证** - 安全的用户身份验证
+- **密码加密** - bcrypt 加密存储
+- **权限控制** - 基于角色的访问控制
+- **审计日志** - 记录所有重要操作
+- **CORS 保护** - 跨域请求保护
+
+## 🛠️ 开发指南
+
+### 本地开发
+
+```bash
+# 克隆仓库
+git clone https://github.com/shijinghao/collabdocchat.git
+cd collabdocchat
+
+# 安装依赖
+npm install
+
+# 启动开发服务器
+npm run dev
+```
+
+### 构建生产版本
+
+```bash
+# 构建前端
+npm run build
+
+# 启动生产服务器
+npm run serve
+```
+
+## 🤝 贡献指南
+
+欢迎贡献代码！请遵循以下步骤：
+
+1. Fork 本仓库
+2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启 Pull Request
+
+## 📝 更新日志
+
+### v1.2.2 (2026-01-26)
+- ✅ 发布到 npm
+- 🔧 修复 package.json 配置
+- 📚 完善文档
+
+### v1.2.0
+- ✨ 添加任务管理功能
+- 🎨 优化 UI 界面
+- 🐛 修复已知问题
+
+### v1.0.0
+- 🎉 首次发布
+- 📝 实时文档协作
+- 💬 即时通讯功能
+
+## 📄 许可证
+
+本项目采用 [MIT](LICENSE) 许可证。
+
+## 👨‍💻 作者
+
+**shijinghao**
+
+- GitHub: [@shijinghao](https://github.com/shijinghao)
+- npm: [collabdocchat](https://www.npmjs.com/package/collabdocchat)
+
+## 🙏 致谢
+
+感谢以下开源项目：
+
+- [Yjs](https://github.com/yjs/yjs) - CRDT 协同编辑
+- [Quill](https://quilljs.com/) - 富文本编辑器
+- [Express](https://expressjs.com/) - Web 框架
+- [MongoDB](https://www.mongodb.com/) - 数据库
+
+## 📞 支持
+
+如果您遇到问题或有建议，请：
+
+- 提交 [Issue](https://github.com/shijinghao/collabdocchat/issues)
+- 发送邮件至项目维护者
+- 查看 [文档](https://github.com/shijinghao/collabdocchat#readme)
+
+## ⭐ Star History
+
+如果这个项目对您有帮助，请给我们一个 Star ⭐️
+
+---
+
+**Made with ❤️ by shijinghao**

package/bin/cli.js

@@ -14,10 +14,24 @@ const isWindows = platform() === 'win32';
 
 // 打开浏览器
 function openBrowser(url) {
-  const command = isWindows ? 'cmd' : (platform() === 'darwin' ? 'open' : 'xdg-open');
-  const args = isWindows ? ['/c', 'start', url] : [url];
-  const browser = spawn(command, args, { stdio: 'ignore', detached: true });
-  browser.unref();
+  try {
+    if (isWindows) {
+      // Windows: 使用 start 命令，需要添加空标题
+      spawn('cmd', ['/c', 'start', '""', url], { 
+        stdio: 'ignore', 
+        detached: true,
+        shell: true 
+      }).unref();
+    } else if (platform() === 'darwin') {
+      // macOS
+      spawn('open', [url], { stdio: 'ignore', detached: true }).unref();
+    } else {
+      // Linux
+      spawn('xdg-open', [url], { stdio: 'ignore', detached: true }).unref();
+    }
+  } catch (error) {
+    console.log(`\n⚠️  无法自动打开浏览器，请手动访问: ${url}`);
+  }
 }
 
 // 检查是否在正确的目录

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "collabdocchat",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "开源的实时协作文档聊天平台 - 集成任务管理、多人文档编辑、智能点名功能",
   "main": "./server/index.js",
   "type": "module",
   "bin": {
-    "collabdocchat": "./bin/cli.js"
+    "collabdocchat": "bin/cli.js"
   },
   "files": [
     "bin",

package/QUICK_START.md

@@ -1,147 +0,0 @@
-# CollabDocChat 快速启动指南 🚀
-
-## 方法一：使用一键启动脚本（推荐）
-
-### Windows 用户
-
-1. 下载启动脚本：
-   ```bash
-   curl -O https://raw.githubusercontent.com/shijinghao/collabdocchat/main/install-and-start.bat
-   ```
-
-2. 双击运行 `install-and-start.bat`
-
-或者在命令行中运行：
-```bash
-install-and-start.bat
-```
-
-### Linux/Mac 用户
-
-1. 下载启动脚本：
-   ```bash
-   curl -O https://raw.githubusercontent.com/shijinghao/collabdocchat/main/install-and-start.sh
-   chmod +x install-and-start.sh
-   ```
-
-2. 运行脚本：
-   ```bash
-   ./install-and-start.sh
-   ```
-
----
-
-## 方法二：手动安装并启动
-
-### 1. 安装（跳过 postinstall 脚本）
-
-```bash
-npm install collabdocchat --ignore-scripts
-```
-
-### 2. 启动
-
-```bash
-cd node_modules/collabdocchat
-node scripts/quick-start.js
-```
-
-或者手动分别启动：
-
-**启动后端：**
-```bash
-cd node_modules/collabdocchat
-node server/index.js
-```
-
-**启动前端（新终端）：**
-```bash
-cd node_modules/collabdocchat
-npm run client
-```
-
-**打开浏览器：**
-访问 `http://localhost:5173`
-
----
-
-## 方法三：一行命令
-
-### Windows (PowerShell)
-
-```powershell
-npm install collabdocchat --ignore-scripts; cd node_modules\collabdocchat; Start-Process node -ArgumentList "server/index.js" -WindowStyle Hidden; Start-Sleep -Seconds 3; Start-Process npm -ArgumentList "run","client" -WindowStyle Hidden; Start-Sleep -Seconds 8; Start-Process "http://localhost:5173"
-```
-
-### Linux/Mac
-
-```bash
-npm install collabdocchat --ignore-scripts && cd node_modules/collabdocchat && node server/index.js & sleep 3 && npm run client & sleep 8 && open http://localhost:5173
-```
-
----
-
-## 停止服务
-
-### Windows
-
-```bash
-taskkill /F /IM node.exe
-```
-
-### Linux/Mac
-
-```bash
-pkill -f node
-```
-
-或者：
-
-```bash
-cd node_modules/collabdocchat
-npm run stop
-```
-
----
-
-## 注意事项
-
-- 确保 MongoDB 已启动
-- 确保端口 3000 和 5173 未被占用
-- 首次运行需要配置 `.env` 文件（可选）
-
----
-
-## 常见问题
-
-### Q: 安装卡住了怎么办？
-
-A: 使用 `--ignore-scripts` 选项：
-```bash
-npm install collabdocchat --ignore-scripts
-```
-
-### Q: 浏览器没有自动打开？
-
-A: 手动访问 `http://localhost:5173`
-
-### Q: 如何查看是否启动成功？
-
-A: 检查端口占用：
-```bash
-# Windows
-netstat -ano | findstr :3000
-netstat -ano | findstr :5173
-
-# Linux/Mac
-lsof -i:3000
-lsof -i:5173
-```
-
----
-
-**提示**: 推荐使用一键启动脚本，最简单快捷！
-
-
-
-