# sucode-web

**Repository Path**: hao-shaopeng58/sucode-web

## Basic Information

- **Project Name**: sucode-web
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-04
- **Last Updated**: 2026-03-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sucode Web

🌐 **Sucode Web** - Sucode iOS 应用的 Web 后端服务

为 Sucode iOS 应用提供 WebSocket 终端服务和后端 API 支持。

---

## ✨ 功能特性

- **🔌 WebSocket 终端** - 实时命令行交互
- **💻 浏览器终端** - 基于 xterm.js 的 Web 终端
- **🔐 安全连接** - Token 认证和会话管理
- **⚡ 高性能** - Node.js + WebSocket 实时通信
- **🐳 Docker 支持** - 一键容器化部署

---

## 🏗️ 技术架构

```
sucode-web/
├── server.js          # Express + WebSocket 服务入口
├── package.json       # 依赖配置
├── Dockerfile         # Docker 构建配置
└── README.md          # 项目文档
```

---

## 🚀 快速开始

### 环境要求
- Node.js 18+
- npm 或 yarn

### 安装运行

```bash
# 克隆项目
git clone https://github.com/Haoshaopeng/sucode-web.git
cd sucode-web

# 安装依赖
npm install

# 启动服务
npm start

# 或使用 PM2 守护进程
npm install -g pm2
pm2 start server.js --name sucode-web
```

### Docker 部署

```bash
# 构建镜像
docker build -t sucode-web .

# 运行容器
docker run -d -p 8765:8765 --name sucode-web sucode-web
```

---

## 📡 API 接口

### WebSocket 终端
```
ws://localhost:8765/terminal?token=YOUR_TOKEN
```

### HTTP 状态检查
```
GET /health          # 服务健康检查
GET /status          # 连接状态统计
```

---

## ⚙️ 配置说明

### 环境变量
```bash
PORT=8765                    # 服务端口
WS_HEARTBEAT_INTERVAL=30000  # WebSocket 心跳间隔(ms)
MAX_CONNECTIONS=100          # 最大并发连接数
```

### PM2 配置
```bash
pm2 start server.js --name sucode-web --max-memory-restart 200M
```

---

## 🔗 关联项目

- **Sucode iOS**: https://github.com/Haoshaopeng/sucode
- **Sucode Web**: https://github.com/Haoshaopeng/sucode-web

---

## 🛠️ 技术栈

| 技术 | 用途 |
|------|------|
| Node.js | 运行时 |
| Express | HTTP 服务 |
| WebSocket (ws) | 实时通信 |
| node-pty | 伪终端 |
| xterm.js | 前端终端 |
| PM2 | 进程管理 |

---

## 📊 性能指标

- 支持 100+ 并发 WebSocket 连接
- 心跳检测 30s 间隔
- 内存占用 < 200MB
- 启动时间 < 3s

---

## 🔧 开发调试

```bash
# 开发模式（热重载）
npm run dev

# 查看日志
pm2 logs sucode-web

# 调试模式
DEBUG=* npm start
```

---

## 📝 使用场景

- 配合 Sucode iOS App 使用
- 作为独立 Web 终端服务
- 嵌入其他应用的终端功能

---

## 📄 许可证

MIT License

---

**Made with ❤️ by haoshaopeng**