docs: 添加部署文档和 README

- 新增 DEPLOY.md 详细部署指南
- 新增 README.md 项目说明
- 更新 .env.example 添加 JWT_SECRET 示例
- 优化 db.js 数据库连接配置(支持端口和超时设置)
This commit is contained in:
jason
2026-03-12 20:47:17 +08:00
parent 96bdc292bb
commit b6a98ddaba
4 changed files with 302 additions and 1 deletions

84
README.md Normal file
View File

@@ -0,0 +1,84 @@
# API Debug Tool
一个用于调试钉钉 API 的 Web 工具,支持多租户管理、接口管理和调试历史记录。
## 功能特性
- ✅ 用户认证与授权JWT
- ✅ 多租户管理支持旗舰版PP/ATS、标品PP/ATS、国际版ATS
- ✅ 接口管理(支持分类和模块)
- ✅ 接口调试(自动签名、参数注入)
- ✅ 调试历史记录
- ✅ 用户数据隔离
- ✅ 多标签页调试
## 技术栈
- **前端**: React + Vite
- **后端**: Node.js + Express
- **数据库**: MySQL 8.0+
- **认证**: JWT
## 快速开始
详细部署文档请查看 [DEPLOY.md](./DEPLOY.md)
### 安装依赖
```bash
npm install
cd server && npm install
cd ../client && npm install
```
### 配置数据库
```bash
cd server
cp .env.example .env
# 编辑 .env 填入数据库配置
```
### 初始化数据库
```bash
mysql -u root -p api_debug < server/init.sql
```
### 启动服务
```bash
# 后端
cd server && npm start
# 前端(新终端)
cd client && npm run dev
```
## 默认账号
- 用户名: `admin`
- 密码: `123456`
## 项目结构
```
api-debug/
├── client/ # 前端项目
│ ├── src/
│ │ ├── components/ # React 组件
│ │ ├── utils/ # 工具函数
│ │ └── main.jsx # 入口文件
│ └── package.json
├── server/ # 后端项目
│ ├── routes/ # API 路由
│ ├── middleware/ # 中间件
│ ├── init.sql # 数据库初始化脚本
│ ├── .env.example # 环境变量示例
│ └── package.json
└── DEPLOY.md # 部署文档
```
## 许可证
MIT License