# 铜伴

**Repository Path**: hdisyq/pytb

## Basic Information

- **Project Name**: 铜伴
- **Description**: 拍照设铜含量
V2.0.2
- **Primary Language**: Python
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-02
- **Last Updated**: 2026-07-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
     <p align="center">
          <img src="frontend/web/public/logo.png" width="150" height="150" alt="logo" />
     </p>
     <h1>Py铜伴系统 <sup style="background-color: #28a745; color: white; padding: 2px 6px; border-radius: 3px; font-size: 0.4em; vertical-align: super; margin-left: 5px;">v2.0.1</sup></h1>
     <h3>🚀 睿拍铜解 - 基于 FastAPI + Vue3 的全栈应用</h3>
     <p>基于 <b>FastAPI + Vue3 + TypeScript</b> 的全栈快速开发平台，Web / H5 / 小程序一站式交付</p>
     <p align="center">
          <a href="https://gitee.com/hdisyq/pytb.git" target="_blank">
               <img src="https://gitee.com/hdisyq/pytb/badge/star.svg?theme=dark" alt="Gitee Stars">
          </a>
          <br>
          <a href="https://gitee.com/hdisyq/pytb/blob/master/LICENSE" target="_blank">
               <img src="https://img.shields.io/badge/License-MIT-orange" alt="License">
          </a>
          <img src="https://img.shields.io/badge/Python-≥3.10-blue">
          <img src="https://img.shields.io/badge/NodeJS-≥20.0-blue">
          <img src="https://img.shields.io/badge/MySQL-≥8.0-blue">
          <img src="https://img.shields.io/badge/Redis-≥7.0-blue">
     </p>

简体中文 | [English](./README.en.md)

</div>

## 💡 项目介绍

Py铜伴系统是基于 FastApiAdmin 开发的定制化应用，专注于铜伴管理和AI识别功能。

| 特性 | 说明 |
|---------|-------------|
| 🎯 **开箱即用**的后台系统 | ✅ 基于 FastApiAdmin 定制 |
| ⚡ **FastAPI 异步**高性能后端 | ✅ 异步处理，高性能 |
| 🔐 **RBAC** 菜单/按钮/数据三级权限 | ✅ 完整权限管理 |
| 📱 **移动端**（H5 + 小程序）一体 | ✅ UniApp 跨平台 |
| 🤖 **AI识别**功能 | ✅ 图片识别、智能分析 |
| 🐳 **Docker 一键部署** | ✅ 含 Nginx + SSL |

## 🚀 5 分钟本地跑起来

```bash
# 1. 克隆
git clone https://gitee.com/hdisyq/pytb.git

# 2. 配置环境
cp backend/env/.env.dev.example backend/env/.env.dev
cp frontend/web/.env.development.example frontend/web/.env.development

# 3. 启动后端（首次自动建表 + 初始化数据）
cd backend && uv sync && uv run main.py run --env=dev

# 4. 启动前端
cd ../frontend/web && pnpm install && pnpm run dev

# ✅ 浏览器打开 http://127.0.0.1:5173，用 admin/123456 登录
```

| 环境要求 |  |
|---------|------|
| Python ≥ 3.10（推荐 3.12） | Node.js ≥ 20.0 + pnpm |
| MySQL 8.0+ / PostgreSQL 14+ | Redis 6.x / 7.x |

## 📦 工程结构

```
pytb/            # Monorepo 全栈工程
├─ backend/              # FastAPI 后端（Pydantic 2.0 + SQLAlchemy + Alembic）
├─ frontend/
│   ├── web/             # Vue3 Web 前端（Element Plus + TypeScript）
│   ├── uniapp/          # UniApp 移动端（H5 + 小程序 + App）
│   └── docs/            # VitePress 文档网站
├─ docker/               # Docker Compose 一键部署（Nginx + SSL）
├─ docs/                 # 项目文档
└─ LICENSE               # MIT 开源协议
```

## 📌 内置功能（开箱即用）

| 模块 | 包含能力 |
|------|---------|
| 📊 仪表盘 | 工作台、数据分析 |
| ⚙️ 系统管理 | 用户 / 角色 / 菜单 / 部门 / 岗位 / 字典 / 配置 / 公告 |
| 📱 铜伴管理 | 识别记录 / 治愈卡片 / 邀请函 / 国际化文本 |
| 🍲 食材库 | 食材管理 / 铜币规则 |
| 📝 日志管理 | 操作日志审计 |
| 🛠 开发工具 | 代码生成、表单构建、接口文档 |
| 📁 文件管理 | 统一文件管理 |
| 🤖 AI功能 | 图片识别、智能分析 |

## 📖 文档地址

- 📁 项目文档：`docs/` 目录
- 📁 子工程 README：[backend](backend/README.md) · [web](frontend/web/README.md) · [UniApp](frontend/uniapp/README.md)

## 🤝 参与贡献

欢迎提交 Issue / PR！详见 [贡献指南](CONTRIBUTING.md)。

## 👥 社区与支持

> 如果你觉得项目有用，请给一个 ⭐️ Star 支持！

## 🙏 鸣谢

- 后端：[FastAPI](https://fastapi.tiangolo.com/) · [Pydantic](https://docs.pydantic.dev/) · [SQLAlchemy](https://www.sqlalchemy.org/) · [APScheduler](https://github.com/agronholm/apscheduler)
- 前端：[Vue3](https://cn.vuejs.org/) · [TypeScript](https://www.typescriptlang.org/) · [Vite](https://vitejs.dev/) · [Element Plus](https://element-plus.org/)
- 移动端：[UniApp](https://uniapp.dcloud.net.cn/) · [Wot Design Uni](https://wot-ui.cn/)
- 基础框架：[FastApiAdmin](https://gitee.com/fastapiadmin/FastapiAdmin)