# empty_project_fastapi_uniapp

**Repository Path**: dszmr/empty_project_fastapi_uniapp

## Basic Information

- **Project Name**: empty_project_fastapi_uniapp
- **Description**: 基于 Python fastapi + vue uniapp  uview-plus 等框架的初始空项目 可用于ai大模型相关项目落地使用
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2025-04-10
- **Last Updated**: 2025-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: FastAPI, uni-app

## README

# empty_project_fastapi_uniapp 项目

这是一个基于Python FastAPI + Vue UniApp + uView Plus 的最精简化空项目，提供了开发多端应用的基础框架和示例。

## 项目特点

- **前端**：使用 Vue 3 + UniApp + uView Plus，支持编译到H5、小程序、App等多端
- **后端**：基于FastAPI构建的高性能API服务，支持异步和WebSocket
- **数据库**：集成SQLite数据库，可扩展支持MySQL、PostgreSQL等
- **示例功能**：包含HelloWorld API调用示例，展示前后端交互

## 重要提示

**由于UniApp的npm包安装存在兼容性问题，请查看 `web/INSTALLATION.md` 文件获取正确的安装指南。**

推荐使用官方HBuilderX创建项目，更易于配置和管理UniApp的环境依赖。

## 项目结构

```
.
├── server/             # 后端服务器
│   ├── main.py         # 主应用入口
│   ├── models.py       # 数据模型
│   ├── routes.py       # API路由
│   ├── requirements.txt # 依赖列表
│   ├── sql/            # SQLite数据库存放目录
│   └── static/         # 静态文件
│
└── web/                # 前端应用
    ├── pages/          # 页面目录
    │   ├── index/      # 首页
    │   └── about/      # 关于页面
    ├── static/         # 静态资源
    ├── uni.scss        # 全局样式变量
    ├── App.vue         # 主组件
    ├── main.js         # 入口文件
    ├── pages.json      # 页面配置
    └── package.json    # 依赖配置
```

## 快速开始

### 后端服务器

1. 进入server目录
```bash
cd server
```

2. 安装依赖
```bash
pip install -r requirements.txt
```

3. 运行服务器
```bash
python main.py
```

服务器将在 http://localhost:8000 运行，可以通过 http://localhost:8000/docs 访问API文档。

### 前端应用

1. 进入web目录
```bash
cd web
```

2. 安装依赖（请参考 `web/INSTALLATION.md` 获取详细指南）
```bash
# 清理之前的安装（如果存在）
rm -rf node_modules
rm package-lock.json

# 安装依赖
npm install
```

3. 运行开发服务器（选择目标平台）

H5平台:
```bash
npm run dev:h5
```

APP平台:
```bash
npm run dev
```

微信小程序:
```bash
npm run dev:mp-weixin
```

4. 打包构建

```bash
# 打包H5版本
npm run build:h5

# 打包APP版本
npm run build:app

# 打包微信小程序版本
npm run build:mp-weixin
```

## 项目配置

### 前端配置

- **UniApp配置**：修改`pages.json`文件
- **UI主题**：修改`uni.scss`文件中的变量
- **API请求**：前端默认将API请求代理到后端服务

### 后端配置

- **数据库配置**：修改`main.py`中的数据库连接参数
- **跨域设置**：已默认配置CORS支持所有来源
- **静态文件**：静态文件存放在`static`目录

## 开发建议

1. 使用VS Code或HBuilderX作为IDE（推荐使用HBuilderX开发UniApp）
2. 安装Vue DevTools进行调试
3. 使用FastAPI提供的自动文档功能查看API
4. 遵循RESTful API设计规范

## 示例功能

本项目提供了一个简单的HelloWorld API调用示例：

- 后端提供`/api/hello`接口，返回问候消息和时间戳
- 前端页面上有一个按钮，点击后会调用此接口并使用uView Plus组件展示结果

## 许可证

MIT