feat: add readme file
This commit is contained in:
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Sub Router
|
||||||
|
|
||||||
|
Surge 代理订阅管理系统。聚合多个上游订阅源,管理自定义节点和规则,生成合并后的 Surge 配置文件。
|
||||||
|
|
||||||
|
## 快速开始
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 安装依赖
|
||||||
|
npm install
|
||||||
|
|
||||||
|
# 开发模式(前后端同时启动)
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# 生产构建
|
||||||
|
npm run build:web
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
|
||||||
|
## Docker 部署
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
服务运行在 `http://localhost:3456`,Surge 订阅地址为 `http://<host>:3456/surge`。
|
||||||
|
|
||||||
|
## 技术栈
|
||||||
|
|
||||||
|
- **后端**: Express + TypeScript + better-sqlite3
|
||||||
|
- **前端**: React + Vite + TypeScript
|
||||||
|
- **数据库**: SQLite
|
||||||
Reference in New Issue
Block a user