|
| 1 | +中文: [README_ZH.md](README_ZH.md) |
| 2 | + |
1 | 3 | <p align="center"> |
2 | 4 | <img src="web-res/image/tlrtcapp-logo.svg" alt="TL-RTC-APP Logo"> |
3 | 5 | </p> |
|
8 | 10 |
|
9 | 11 | ### Installation Steps |
10 | 12 |
|
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 |
18 | 14 |
|
19 | 15 | ```bash |
20 | | - cd tl-rtc-app |
| 16 | + Make sure Node.js (v16+), npm, MySQL (5.7+), and Redis (4.0+) are installed. |
21 | 17 | ``` |
22 | 18 |
|
23 | | -3. Install dependencies: |
| 19 | +2. Clone the repository: |
24 | 20 |
|
25 | 21 | ```bash |
26 | | - npm install |
| 22 | + git clone https://github.com/tl-open-source/tl-rtc-app.git |
27 | 23 | ``` |
28 | 24 |
|
29 | | -4. Install pm2 globally: |
| 25 | +3. Enter the project directory: |
30 | 26 |
|
31 | 27 | ```bash |
32 | | - npm install pm2 -g |
| 28 | + cd tl-rtc-app |
33 | 29 | ``` |
34 | 30 |
|
35 | | -5. Start the super admin API service: |
| 31 | +4. Install dependencies: |
36 | 32 |
|
37 | 33 | ```bash |
38 | | - pm2 start npm --name=tl-rtc-app-super-api -- run http-super-api |
| 34 | + npm install |
39 | 35 | ``` |
40 | | - or |
| 36 | + |
| 37 | +5. Install pm2 globally: |
41 | 38 |
|
42 | 39 | ```bash |
43 | | - pm2 start npm --name=tl-rtc-app-super-api -- run https-super-api |
| 40 | + npm install pm2 -g |
44 | 41 | ``` |
45 | 42 |
|
46 | | -6. Start the API service: |
| 43 | +6. Start the service: |
47 | 44 |
|
48 | 45 | ```bash |
49 | | - pm2 start npm --name=tl-rtc-app-api -- run http-api |
| 46 | + npm run http |
50 | 47 | ``` |
51 | | - or |
| 48 | + Or (for audio/video, screen sharing, live streaming, etc.): |
52 | 49 |
|
53 | 50 | ```bash |
54 | | - pm2 start npm --name=tl-rtc-app-api -- run https-api |
| 51 | + npm run https |
55 | 52 | ``` |
56 | 53 |
|
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: |
63 | 55 |
|
64 | 56 | ```bash |
65 | | - pm2 start npm --name=tl-rtc-app-socket -- run https-socket |
| 57 | + gulp default |
66 | 58 | ``` |
67 | 59 |
|
68 | | -### Usage |
| 60 | +### Usage Instructions |
69 | 61 |
|
70 | | -1. Open your browser and visit `http://localhost:9096` (default). |
| 62 | +1. Open your browser and visit `http://localhost:9096` (by default). |
71 | 63 |
|
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). |
73 | 65 |
|
74 | 66 | ### License |
75 | 67 |
|
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. |
77 | 69 |
|
78 | 70 | ### Disclaimer |
79 | 71 |
|
|
0 commit comments