Skip to content

START_GUIDE.md

Latest commit

 

History

History
151 lines (112 loc) · 3.54 KB

START_GUIDE.md

File metadata and controls

151 lines (112 loc) · 3.54 KB
Raw

🚀 API Router 一键启动指南

本项目提供了多种启动脚本，适用于不同的操作系统和环境。

📋 启动脚本列表

Windows 用户

1. start.bat (批处理文件)

  • 适用: Windows 系统
  • 使用方法: 双击 start.bat 文件
  • 特点: 简单易用，自动检查依赖

2. start.ps1 (PowerShell 脚本) ✅ 已修复

  • 适用: Windows PowerShell
  • 使用方法: 
    # 在 PowerShell 中运行
.\start.ps1

# 或者右键选择 "使用 PowerShell 运行"
  • 特点: 彩色输出，更好的错误处理，已修复跨平台兼容性问题

Linux/macOS 用户

3. start.sh (Bash 脚本)

  • 适用: Linux, macOS, WSL
  • 使用方法: 
    # 添加执行权限（首次使用）
chmod +x start.sh

# 运行脚本
./start.sh
  • 特点: 跨平台兼容，彩色终端输出

🔧 脚本功能

所有启动脚本都包含以下功能：

✅ 自动检查

  • Node.js 安装检查: 确保 Node.js 已正确安装
  • 依赖包检查: 自动安装缺失的 npm 依赖
  • 数据库文件检查: 检查 db.json 是否存在

🚀 服务器启动

  • 启动 API Router 服务器（端口 3001）
  • 显示服务器地址和状态信息
  • 提供清晰的启动日志

🛡️ 错误处理

  • 友好的错误提示
  • 自动故障排除建议
  • 优雅的退出处理

📖 使用步骤

首次使用

  1. 选择适合的启动脚本

    • Windows: 推荐使用 start.bat
    • PowerShell 用户: 使用 start.ps1
    • Linux/macOS: 使用 start.sh

  2. 运行启动脚本

    • 脚本会自动检查并安装依赖
    • 等待服务器启动完成

  3. 验证服务器运行

    • 浏览器访问: http://localhost:3001
    • 或使用验证脚本: node verify-fix.js

日常使用

  1. 启动服务器: 运行对应的启动脚本
  2. 停止服务器: 按 Ctrl+C
  3. 重启服务器: 停止后重新运行脚本

🔍 故障排除

常见问题

1. "未找到 Node.js"

解决方案:

  • 下载并安装 Node.js: https://nodejs.org/
  • 重启终端/命令提示符
  • 重新运行启动脚本

2. "依赖安装失败"

解决方案:

# 清除缓存并重新安装
npm cache clean --force
npm install

3. "端口 3001 被占用"

解决方案:

# Windows
netstat -ano | findstr :3001
taskkill /PID <进程ID> /F

# Linux/macOS
lsof -ti:3001 | xargs kill -9

4. PowerShell 执行策略错误

解决方案:

# 临时允许脚本执行
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

🎯 快速验证

启动服务器后，可以使用以下方法验证：

1. 浏览器测试

访问: http://localhost:3001

2. 命令行验证

node verify-fix.js

3. API 测试

curl http://localhost:3001/v1/models

📝 注意事项

  1. 首次运行: 可能需要较长时间安装依赖
  2. 网络要求: 需要互联网连接以下载依赖包
  3. 权限要求: Linux/macOS 用户需要执行权限
  4. 端口占用: 确保端口 3001 未被其他程序占用

🆘 获取帮助

如果遇到问题，请检查：

  1. 错误日志: 查看终端输出的错误信息
  2. 系统要求: 确保满足 Node.js 版本要求
  3. 网络连接: 确保能够访问 npm 仓库
  4. 文件权限: 确保有读写项目文件的权限

提示: 推荐使用 start.bat（Windows）或 start.sh（Linux/macOS）进行日常启动，这些脚本经过优化，提供最佳的用户体验。