# Web Terminal Server

**Repository Path**: mikenchen/web-terminal-server

## Basic Information

- **Project Name**: Web Terminal Server
- **Description**: 使用NodeJS搭建的Express服务，提供Terminal接口
- **Primary Language**: TypeScript
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-02-06
- **Last Updated**: 2025-02-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Web Terminal Server

#### 介绍
使用NodeJS搭建的Express服务

客户端地址：[https://gitee.com/mikenchen/web-terminal-client](https://gitee.com/mikenchen/web-terminal-client)

#### 软件架构
| 依赖包      | 说明     |
|----------|--------|
| Express  | API服务  |
| node-pty | 提供终端服务 |


#### 安装教程

```
1.  git clone https://gitee.com/mikenchen/web-terminal-server.git
2.  cd web-terminal-server
3.  pnpm install
4.  pnpm run start 或 pnpm run start:win
````


#### 前端代码

```
1.  git clone https://gitee.com/mikenchen/web-terminal-client.git
2.  cd web-terminal-client
3.  pnpm install
4.  pnpm run dev
````

#### 使用说明

1.  [node-pty](https://www.npmjs.com/package/node-pty)安装比较麻烦，windows需要安装windows-build-tools，如果不需要使用terminal终端，可屏蔽相关依赖包和代码入口
```
npm install --global --production windows-build-tools
```
2. windows下，如果terminal终端出现乱码，可在启动脚本加入  **chcp 65001**