Skip to content

Commit 1415e30

Browse files
committed
feat: 支持共享剪贴板/优化部署流程/文档更新
1 parent 2c7f221 commit 1415e30

37 files changed

+6510
-70
lines changed

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
中文: [README_ZH.md](README_ZH.md)
2+
13
<p align="center">
24
<img src="web-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo">
35
</p>
@@ -8,72 +10,62 @@
810

911
### Installation Steps
1012

11-
1. Clone the repository:
12-
13-
```bash
14-
git clone https://github.com/tl-open-source/tl-rtc-app.git
15-
```
16-
17-
2. Navigate into the project directory:
13+
1. Prerequisites
1814

1915
```bash
20-
cd tl-rtc-app
16+
Make sure Node.js (v16+), npm, MySQL (5.7+), and Redis (4.0+) are installed.
2117
```
2218

23-
3. Install dependencies:
19+
2. Clone the repository:
2420

2521
```bash
26-
npm install
22+
git clone https://github.com/tl-open-source/tl-rtc-app.git
2723
```
2824

29-
4. Install pm2 globally:
25+
3. Enter the project directory:
3026

3127
```bash
32-
npm install pm2 -g
28+
cd tl-rtc-app
3329
```
3430

35-
5. Start the super admin API service:
31+
4. Install dependencies:
3632

3733
```bash
38-
pm2 start npm --name=tl-rtc-app-super-api -- run http-super-api
34+
npm install
3935
```
40-
or
36+
37+
5. Install pm2 globally:
4138

4239
```bash
43-
pm2 start npm --name=tl-rtc-app-super-api -- run https-super-api
40+
npm install pm2 -g
4441
```
4542

46-
6. Start the API service:
43+
6. Start the service:
4744

4845
```bash
49-
pm2 start npm --name=tl-rtc-app-api -- run http-api
46+
npm run http
5047
```
51-
or
48+
Or (for audio/video, screen sharing, live streaming, etc.):
5249

5350
```bash
54-
pm2 start npm --name=tl-rtc-app-api -- run https-api
51+
npm run https
5552
```
5653

57-
7. Start the Socket service:
58-
59-
```bash
60-
pm2 start npm --name=tl-rtc-app-socket -- run http-socket
61-
```
62-
or
54+
7. Build frontend resources:
6355

6456
```bash
65-
pm2 start npm --name=tl-rtc-app-socket -- run https-socket
57+
gulp default
6658
```
6759

68-
### Usage
60+
### Usage Instructions
6961

70-
1. Open your browser and visit `http://localhost:9096` (default).
62+
1. Open your browser and visit `http://localhost:9096` (by default).
7163

72-
2. Use the admin panel for managing the IM application at `http://localhost:9098` (default).
64+
2. Manage IM applications through the admin panel at `http://localhost:9098/system.html` (by default).
7365

7466
### License
7567

76-
This project is licensed under the MIT License. For more information, please refer to the [LICENSE](LICENSE) file.
68+
This project is licensed under the MIT License. For more details, please refer to the [LICENSE](LICENSE) file.
7769

7870
### Disclaimer
7971

README_ZH.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
英文: [README.md](README.md)
2+
13
<p align="center">
24
<img src="web-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo">
35
</p>
@@ -6,71 +8,61 @@
68
<img src="web-res/image/channel-chat.png" alt="TL-RTC-APP Channel Chat">
79
</p>
810

9-
1011
### 安装步骤
1112

12-
1. 克隆仓库:
13+
1. 前提条件
1314

1415
```bash
15-
git clone https://github.com/tl-open-source/tl-rtc-app.git
16+
确保已安装 Node.js (v16+) 和 npm,mysql(5.7+), redis(4.0+)。
1617
```
17-
18-
2. 进入项目目录:
1918

20-
```bash
21-
cd tl-rtc-app
22-
```
23-
24-
3. 安装依赖:
19+
2. 克隆仓库:
2520

2621
```bash
27-
npm install
22+
git clone https://github.com/tl-open-source/tl-rtc-app.git
2823
```
2924

30-
4. 安装pm2:
25+
3. 进入项目目录:
3126

3227
```bash
33-
npm install pm2 -g
28+
cd tl-rtc-app
3429
```
3530

36-
5. 启动后台管理服务
31+
4. 安装依赖
3732

3833
```bash
39-
pm2 start npm --name=tl-rtc-app-super-api -- run http-super-api
34+
npm install
4035
```
41-
或者
36+
37+
5. 安装pm2:
4238

4339
```bash
44-
pm2 start npm --name=tl-rtc-app-super-api -- run https-super-api
40+
npm install pm2 -g
4541
```
4642

47-
6. 启动Api服务
43+
6. 启动服务
4844

4945
```bash
50-
pm2 start npm --name=tl-rtc-app-api -- run http-api
46+
npm run http
5147
```
52-
或者
48+
或者 (如需体验音视频/屏幕共享/直播等功能):
5349

5450
```bash
55-
pm2 start npm --name=tl-rtc-app-api -- run https-api
51+
npm run https
5652
```
5753

58-
7. 启动Socket服务:
54+
7. 打包前端资源:
5955

6056
```bash
61-
pm2 start npm --name=tl-rtc-app-socket -- run http-socket
57+
gulp default
6258
```
63-
或者
6459

65-
```bash
66-
pm2 start npm --name=tl-rtc-app-socket -- run https-socket
67-
```
6860

6961
### 使用说明
7062

7163
1. 打开浏览器并访问 `http://localhost:9096` (默认)。
7264

73-
2. 通过管理端应用进行IM应用管理 `http://localhost:9098` (默认)。
65+
2. 通过管理端应用进行IM应用管理 `http://localhost:9098/system.html` (默认)。
7466

7567

7668
### 许可证

gulpfile.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,13 @@ const web_module_js = () => {
211211
'./web-res/js/module/contact/content/search_group.js',
212212
'./web-res/js/module/contact/content.js',
213213

214+
//cut_paste模块
215+
'./web-res/js/module/cut_paste/top.js',
216+
'./web-res/js/module/cut_paste/list.js',
217+
'./web-res/js/module/cut_paste/cut_paste.js',
218+
// cut_paste-content模块
219+
'./web-res/js/module/cut_paste/content.js',
220+
214221
//setting模块
215222
'./web-res/js/module/setting/list.js',
216223
'./web-res/js/module/setting/setting.js',

package.json

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
{
22
"name": "tl-rtc-app",
3-
"version": "0.0.2",
4-
"description": "webrtc, video, draw, chat",
3+
"version": "0.0.3",
4+
"description": "webrtc, p2p, file, video, draw, chat",
55
"scripts": {
6-
"http-api": "cross-env tl_rtc_app_env_mode=http node tlapi",
7-
"http-super-api": "cross-env tl_rtc_app_env_mode=http node tlsuperapi",
8-
"http-socket": "cross-env tl_rtc_app_env_mode=http node tlsocket",
9-
"https-api": "cross-env tl_rtc_app_env_mode=https node tlapi",
10-
"https-super-api": "cross-env tl_rtc_app_env_mode=https node tlsuperapi",
11-
"https-socket": "cross-env tl_rtc_app_env_mode=https node tlsocket"
6+
"http": "pm2 start pm2.config.http.json",
7+
"https": "pm2 start pm2.config.https.json"
128
},
139
"repository": {
1410
"type": "git",

pm2.config.http.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"apps": [
3+
{
4+
"name": "tl-rtc-app-super-api",
5+
"script": "node tlsuperapi",
6+
"instances": 1,
7+
"max_memory_restart": "500M",
8+
"env": {
9+
"tl_rtc_app_env_mode": "http"
10+
}
11+
},
12+
{
13+
"name": "tl-rtc-app-api",
14+
"script": "node tlapi",
15+
"instances": 1,
16+
"max_memory_restart": "500M",
17+
"env": {
18+
"tl_rtc_app_env_mode": "http"
19+
}
20+
},
21+
{
22+
"name": "tl-rtc-app-socket",
23+
"script": "node tlsocket",
24+
"instances": 1,
25+
"max_memory_restart": "500M",
26+
"env": {
27+
"tl_rtc_app_env_mode": "http"
28+
}
29+
}
30+
]
31+
}

pm2.config.https.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"apps": [
3+
{
4+
"name": "tl-rtc-app-super-api",
5+
"script": "node tlsuperapi",
6+
"instances": 1,
7+
"max_memory_restart": "500M",
8+
"env": {
9+
"tl_rtc_app_env_mode": "https"
10+
}
11+
},
12+
{
13+
"name": "tl-rtc-app-api",
14+
"script": "node tlapi",
15+
"instances": 1,
16+
"max_memory_restart": "500M",
17+
"env": {
18+
"tl_rtc_app_env_mode": "https"
19+
}
20+
},
21+
{
22+
"name": "tl-rtc-app-socket",
23+
"script": "node tlsocket",
24+
"instances": 1,
25+
"max_memory_restart": "500M",
26+
"env": {
27+
"tl_rtc_app_env_mode": "https"
28+
}
29+
}
30+
]
31+
}

0 commit comments

Comments
 (0)