Files
Web_BAI_Manage_ApiServer/README.md

114 lines
2.9 KiB
Markdown
Raw Normal View History

# BAI Management System
2026-03-18 11:45:11 +08:00
## 项目概述
BAI管理系统是一个前后端分离的系统包含API接口和Web后台管理部分。该系统为微信小程序前端和Web后台管理提供服务支持。
## 系统架构
```
┌───────────────┐ ┌───────────────┐
│ 微信小程序前端 │ │ Web后台管理 │
└───────────────┘ └───────────────┘
│ │
└─────────┬───────────┘
┌───────────────────┐
│ API接口服务 │
└───────────────────┘
┌─────────┴─────────┐
▼ ▼
┌───────────────┐ ┌───────────────┐
│ 数据库服务 │ │ AI交互服务 │
└───────────────┘ └───────────────┘
```
## 项目结构
```
Web_BAI_Manage_ApiServer/
├── back-end/ # 后端API服务
├── front-end/ # Web后台管理前端
├── docs/ # 项目文档
│ ├── project.md # 项目规则文件
│ ├── frontend.md # 前端功能文档
│ ├── backend.md # 后端功能文档
│ ├── api.md # API接口文档
│ └── deployment.md # 部署文档
└── README.md # 项目说明文档
```
## 技术栈
### 后端
- Node.js 22+
- Express.js
- Pocketbase (数据库)
### 前端
- Vue 3.x
- Element Plus
- Vue Router
- Pinia
## 快速开始
## 域名与 HTTPS 配置
项目正式环境后端域名为:`https://bai-api.blv-oa.com`
- 后端公开地址建议通过 `back-end/.env` 中的以下配置统一控制:
- `APP_PROTOCOL=https`
- `APP_DOMAIN=bai-api.blv-oa.com`
- `APP_BASE_URL=https://bai-api.blv-oa.com`
- 前端生产环境接口地址建议通过 `front-end/.env.production` 中的 `VUE_APP_BASE_URL` 控制:
- `VUE_APP_BASE_URL='https://bai-api.blv-oa.com/api'`
如后续更换域名,优先修改 `.env` 文件,不建议在代码中硬编码域名。
### 后端服务
1. 进入后端目录
```bash
cd back-end
```
2. 安装依赖
```bash
npm install
```
3. 启动开发服务器
```bash
npm run dev
```
### 前端服务
1. 进入前端目录
```bash
cd front-end
```
2. 安装依赖
```bash
npm install --legacy-peer-deps
```
3. 启动开发服务器
```bash
npm run serve
```
## 文档
- [项目规则](docs/project.md)
- [前端功能文档](docs/frontend.md)
- [后端功能文档](docs/backend.md)
- [API接口文档](docs/api.md)
- [部署文档](docs/deployment.md)
## 许可证
ISC License