XuJiacheng
6d713c22ed
添加前后端Dockerfile和docker-compose配置 创建部署脚本deploy.sh 完善项目文档结构包括前后端文档、API文档和部署文档 更新README提供项目概述和快速开始指南 文档包括详细的技术栈说明、功能模块介绍和部署指南 部署方案支持一键式容器化部署和宝塔面板集成
101 lines
2.4 KiB
Markdown
101 lines
2.4 KiB
Markdown
# BAI Management System
|
||
|
||
## 项目概述
|
||
|
||
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
|
||
|
||
## 快速开始
|
||
|
||
### 后端服务
|
||
|
||
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 |