Initial commit: Telegram Management System
Some checks failed
Deploy / deploy (push) Has been cancelled
Some checks failed
Deploy / deploy (push) Has been cancelled
Full-stack web application for Telegram management - Frontend: Vue 3 + Vben Admin - Backend: NestJS - Features: User management, group broadcast, statistics 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
67
README.md
Normal file
67
README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Telegram Management System
|
||||
|
||||
Telegram 管理系统由一套 Node.js 后端(集成 gramJS)和两套前端管理界面组成,覆盖账号管理、消息监控、代理配置等业务能力。
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
telegram-management-system/
|
||||
├── backend/ # Node.js + Hapi + Sequelize + gramJS 后端服务
|
||||
├── frontend/ # 旧版 Vue 2 + View UI Plus 管理台(仅保留参考)
|
||||
├── frontend-vben/ # 新版 Vue 3 + Vite + Vben Admin 管理台
|
||||
├── scripts & docs # 启动脚本、部署指南、调试脚本与相关文档
|
||||
└── README.md
|
||||
```
|
||||
|
||||
## 🚀 后端(backend/)
|
||||
|
||||
- 技术栈:Node.js 18+、Hapi.js、Sequelize、Redis、MySQL、gramJS。
|
||||
- 功能:Telegram 账号管理、实时监控 WebSocket(默认端口 `18081`)、代理管理、任务调度等。
|
||||
- 启动方式:
|
||||
```bash
|
||||
cd backend
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
- 亦可在仓库根目录执行 `./start-background.sh` 同时拉起后端与推荐前端。
|
||||
|
||||
## 💻 前端(推荐使用 `frontend-vben/`)
|
||||
|
||||
### `frontend-vben/`
|
||||
- 技术栈:Vue 3、TypeScript、Vite、Vben Admin、TanStack。
|
||||
- 依赖安装及启动:
|
||||
```bash
|
||||
corepack enable # 确保 pnpm 可用
|
||||
cd frontend-vben
|
||||
pnpm install
|
||||
pnpm dev:antd
|
||||
```
|
||||
- 默认开发地址:`http://localhost:5173/`(如端口占用将自动顺延,具体以终端输出为准)。
|
||||
|
||||
### `frontend/`(Legacy)
|
||||
- 早期的 Vue 2 + View UI Plus 实现,保留作参考。目前未做同步维护,默认启动脚本已改为 `frontend-vben` 版本。
|
||||
|
||||
## 📦 一键启动脚本
|
||||
|
||||
在仓库根目录执行:
|
||||
```bash
|
||||
./start-background.sh
|
||||
```
|
||||
- 启动 Node 后端(API:`http://localhost:3000`,实时监控 WS:`ws://localhost:18081`)。
|
||||
- 启动 Vben 前端(开发服,默认端口 5173)。
|
||||
- 可通过环境变量覆盖:
|
||||
- `REALTIME_MONITOR_PORT`:实时监控 WebSocket 端口。
|
||||
- `FRONTEND_PORT`:Vben 前端端口。
|
||||
|
||||
停止服务:
|
||||
```bash
|
||||
./stop-services.sh
|
||||
```
|
||||
|
||||
## 📚 文档与运维
|
||||
|
||||
- `DEPLOYMENT.md`:生产部署、环境搭建、配置说明。
|
||||
- `OPERATIONS.md`:日常运维、监控告警、故障排查建议。
|
||||
- 其余 `*.md` 文件记录了各阶段联调成果与专项功能说明,可按需查阅。
|
||||
|
||||
> **提示**:项目内 Java(SpringBoot)实现已移除,当前唯一后端实现即 `backend/` 目录的 Node.js 服务。
|
||||
Reference in New Issue
Block a user