collabdocchat 1.2.5 → 1.2.7

package/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# 贡献指南
+
+感谢你考虑为 CollabDocChat 做出贡献！
+
+## 如何贡献
+
+### 报告 Bug
+
+如果你发现了 bug，请创建一个 issue 并包含以下信息：
+
+- Bug 的详细描述
+- 复现步骤
+- 预期行为
+- 实际行为
+- 截图（如果适用）
+- 环境信息（操作系统、Node.js 版本等）
+
+### 提出新功能
+
+如果你有新功能的想法：
+
+1. 先检查 issues 中是否已有类似建议
+2. 创建一个新的 issue，标记为 "enhancement"
+3. 详细描述功能需求和使用场景
+4. 等待社区讨论和反馈
+
+### 提交代码
+
+1. **Fork 项目**
+   ```bash
+   git clone https://github.com/yourusername/collabdocchat.git
+   cd collabdocchat
+   ```
+
+2. **创建分支**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+3. **编写代码**
+   - 遵循项目的代码风格
+   - 添加必要的注释
+   - 确保代码可以正常运行
+
+4. **测试**
+   ```bash
+   npm run dev
+   # 测试你的更改
+   ```
+
+5. **提交更改**
+   ```bash
+   git add .
+   git commit -m "feat: 添加某某功能"
+   ```
+
+   提交信息格式：
+   - `feat:` 新功能
+   - `fix:` 修复 bug
+   - `docs:` 文档更新
+   - `style:` 代码格式调整
+   - `refactor:` 代码重构
+   - `test:` 测试相关
+   - `chore:` 构建/工具相关
+
+6. **推送到 GitHub**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+7. **创建 Pull Request**
+   - 在 GitHub 上创建 PR
+   - 详细描述你的更改
+   - 关联相关的 issue
+
+## 代码规范
+
+### JavaScript 风格
+
+- 使用 ES6+ 语法
+- 使用 2 空格缩进
+- 使用单引号
+- 函数和变量使用驼峰命名
+- 常量使用大写下划线命名
+
+### 文件组织
+
+- 每个文件只导出一个主要功能
+- 相关功能放在同一目录
+- 使用清晰的文件命名
+
+### 注释
+
+- 为复杂逻辑添加注释
+- 使用 JSDoc 格式注释函数
+- 保持注释简洁明了
+
+## 开发流程
+
+1. 在本地开发和测试
+2. 确保代码符合规范
+3. 提交 PR 前先 pull 最新代码
+4. 等待代码审查
+5. 根据反馈修改代码
+6. 合并到主分支
+
+## 社区准则
+
+- 尊重所有贡献者
+- 保持友好和专业
+- 接受建设性批评
+- 帮助新手贡献者
+
+## 问题？
+
+如有任何问题，请：
+- 查看 [README.md](README.md)
+- 搜索现有 issues
+- 创建新的 issue
+- 发送邮件至 your.email@example.com
+
+再次感谢你的贡献！🎉
+
+

package/INSTALLATION.md

@@ -0,0 +1,345 @@
+# CollabDocChat 安装指南
+
+## 📦 安装方式
+
+### 方式一：本地安装（推荐）
+
+这是最简单且最可靠的安装方式：
+
+```bash
+# 1. 创建项目目录
+mkdir my-collab-project
+cd my-collab-project
+
+# 2. 初始化 npm 项目
+npm init -y
+
+# 3. 安装 CollabDocChat
+npm install collabdocchat
+
+# 4. 进入安装目录
+cd node_modules/collabdocchat
+
+# 5. 启动应用
+npm start
+```
+
+### 方式二：克隆仓库
+
+适合开发者和需要自定义的用户：
+
+```bash
+# 1. 克隆项目
+git clone https://github.com/shijinghao/collabdocchat.git
+cd collabdocchat
+
+# 2. 安装依赖
+npm install
+
+# 3. 启动应用
+npm start
+```
+
+### 方式三：使用安装脚本
+
+#### Windows 用户
+
+1. 下载 `install-and-start.bat`
+2. 双击运行或在命令行中执行：
+```cmd
+install-and-start.bat
+```
+
+#### Linux/Mac 用户
+
+1. 下载 `install-and-start.sh`
+2. 添加执行权限并运行：
+```bash
+chmod +x install-and-start.sh
+./install-and-start.sh
+```
+
+## 🔧 环境要求
+
+### 必需软件
+
+1. **Node.js** (>= 16.0.0)
+   - 下载地址: https://nodejs.org/
+   - 验证安装: `node --version`
+
+2. **npm** (>= 7.0.0)
+   - 通常随 Node.js 一起安装
+   - 验证安装: `npm --version`
+
+3. **MongoDB** (>= 4.4)
+   - 下载地址: https://www.mongodb.com/try/download/community
+   - 验证安装: `mongod --version`
+
+### MongoDB 安装指南
+
+#### Windows
+
+1. 下载 MongoDB Community Server
+2. 运行安装程序，选择"Complete"安装
+3. 安装 MongoDB Compass (可选的图形界面)
+4. 启动 MongoDB 服务：
+```cmd
+net start MongoDB
+```
+
+#### Mac (使用 Homebrew)
+
+```bash
+# 安装 MongoDB
+brew tap mongodb/brew
+brew install mongodb-community
+
+# 启动 MongoDB
+brew services start mongodb-community
+```
+
+#### Linux (Ubuntu/Debian)
+
+```bash
+# 导入公钥
+wget -qO - https://www.mongodb.org/static/pgp/server-6.0.asc | sudo apt-key add -
+
+# 添加源
+echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/6.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list
+
+# 安装
+sudo apt-get update
+sudo apt-get install -y mongodb-org
+
+# 启动服务
+sudo systemctl start mongod
+sudo systemctl enable mongod
+```
+
+## ⚙️ 配置
+
+### 首次运行
+
+首次运行时，应用会自动创建配置文件。您也可以手动创建 `.env` 文件：
+
+```env
+# 服务器配置
+PORT=3000
+NODE_ENV=development
+
+# MongoDB 配置
+MONGODB_URI=mongodb://localhost:27017/collabdocchat
+
+# JWT 配置
+JWT_SECRET=your-secret-key-change-this-in-production
+JWT_EXPIRES_IN=7d
+
+# 管理员账号（首次启动时创建）
+ADMIN_USERNAME=admin
+ADMIN_PASSWORD=admin123
+ADMIN_EMAIL=admin@example.com
+```
+
+### 配置说明
+
+- **PORT**: 服务器端口，默认 3000
+- **MONGODB_URI**: MongoDB 连接字符串
+- **JWT_SECRET**: JWT 密钥，生产环境请务必修改
+- **JWT_EXPIRES_IN**: Token 过期时间
+- **ADMIN_USERNAME/PASSWORD**: 默认管理员账号
+
+## 🚀 启动应用
+
+### 开发模式
+
+```bash
+npm run dev
+```
+
+特点：
+- 自动重启服务器
+- 热重载前端
+- 自动打开浏览器
+
+### 生产模式
+
+```bash
+npm start
+```
+
+### 快速启动
+
+```bash
+npm run quick-start
+```
+
+自动配置并启动应用。
+
+## 🔍 验证安装
+
+### 1. 检查服务器
+
+访问: http://localhost:3000
+
+应该看到登录页面。
+
+### 2. 检查客户端
+
+访问: http://localhost:5173
+
+应该看到应用界面。
+
+### 3. 登录测试
+
+使用默认管理员账号登录：
+- 用户名: `admin`
+- 密码: `admin123`
+
+## ❌ 常见问题
+
+### 问题 1: MongoDB 连接失败
+
+**错误信息**: `MongoNetworkError: connect ECONNREFUSED`
+
+**解决方案**:
+1. 确认 MongoDB 服务已启动
+2. 检查 `.env` 中的 `MONGODB_URI` 配置
+3. 验证 MongoDB 端口 (默认 27017)
+
+```bash
+# Windows
+net start MongoDB
+
+# Mac
+brew services start mongodb-community
+
+# Linux
+sudo systemctl start mongod
+```
+
+### 问题 2: 端口被占用
+
+**错误信息**: `Error: listen EADDRINUSE: address already in use :::3000`
+
+**解决方案**:
+1. 更改 `.env` 中的 `PORT` 配置
+2. 或者停止占用端口的进程
+
+```bash
+# Windows - 查找并结束进程
+netstat -ano | findstr :3000
+taskkill /PID <进程ID> /F
+
+# Mac/Linux
+lsof -ti:3000 | xargs kill -9
+```
+
+### 问题 3: npm 依赖安装失败
+
+**解决方案**:
+```bash
+# 清除缓存
+npm cache clean --force
+
+# 删除 node_modules
+rm -rf node_modules package-lock.json
+
+# 重新安装
+npm install
+```
+
+### 问题 4: Node.js 版本过低
+
+**错误信息**: `Error: The engine "node" is incompatible`
+
+**解决方案**:
+升级 Node.js 到 16.0.0 或更高版本。
+
+## 🛑 停止应用
+
+### 方法一：使用脚本
+
+```bash
+npm run stop
+```
+
+### 方法二：手动停止
+
+在运行应用的终端按 `Ctrl + C`
+
+### 方法三：结束进程
+
+```bash
+# Windows
+taskkill /F /IM node.exe
+
+# Mac/Linux
+pkill -f node
+```
+
+## 📊 性能优化
+
+### 生产环境建议
+
+1. **使用 PM2 管理进程**:
+```bash
+npm install -g pm2
+pm2 start server/index.js --name collabdocchat
+pm2 startup
+pm2 save
+```
+
+2. **配置反向代理** (Nginx):
+```nginx
+server {
+    listen 80;
+    server_name your-domain.com;
+
+    location / {
+        proxy_pass http://localhost:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+}
+```
+
+3. **启用 MongoDB 认证**:
+```javascript
+// .env
+MONGODB_URI=mongodb://username:password@localhost:27017/collabdocchat?authSource=admin
+```
+
+## 🔐 安全建议
+
+1. **修改默认管理员密码**
+2. **使用强 JWT 密钥**
+3. **启用 HTTPS**
+4. **配置防火墙规则**
+5. **定期更新依赖包**
+
+```bash
+npm audit
+npm audit fix
+```
+
+## 📞 获取帮助
+
+如果遇到问题：
+
+1. 查看 [GitHub Issues](https://github.com/shijinghao/collabdocchat/issues)
+2. 阅读 [完整文档](https://github.com/shijinghao/collabdocchat#readme)
+3. 提交新的 Issue
+
+## 🎉 安装成功！
+
+现在您可以：
+- 创建文档并邀请团队成员协作
+- 使用实时聊天功能
+- 管理任务和项目
+- 探索更多功能
+
+祝您使用愉快！🚀
+

package/README.md

@@ -226,10 +226,20 @@ npm run serve
 
 ## 📝 更新日志
 
+### v1.2.5 (2026-01-26)
+- 🔧 修复 Windows 下 CLI 启动问题
+- 📚 优化安装和使用说明
+- ✨ 简化启动流程
+
+### v1.2.4 (2026-01-26)
+- 🐛 修复浏览器自动打开功能
+
+### v1.2.3 (2026-01-26)
+- 📚 添加完整的 README 文档
+
 ### v1.2.2 (2026-01-26)
-- ✅ 发布到 npm
+- ✅ 首次发布到 npm
 - 🔧 修复 package.json 配置
-- 📚 完善文档
 
 ### v1.2.0
 - ✨ 添加任务管理功能

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "collabdocchat",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "开源的实时协作文档聊天平台 - 集成任务管理、多人文档编辑、智能点名功能",
   "main": "./server/index.js",
   "type": "module",
@@ -20,7 +20,9 @@
     ".gitignore",
     "install-and-start.bat",
     "install-and-start.sh",
-    "QUICK_START.md"
+    "QUICK_START.md",
+    "INSTALLATION.md",
+    "CONTRIBUTING.md"
   ],
   "keywords": [
     "collaboration",