# Qcode

**Repository Path**: miniwhite/qcode

## Basic Information

- **Project Name**: Qcode
- **Description**: 生成二维码
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-13
- **Last Updated**: 2025-11-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Qcode - 二维码生成器

一个基于Python Flask的现代化二维码生成与美化工具，灵感来自[mh.cli.im](https://mh.cli.im)。

## 功能特色

- 🎨 **自定义样式** - 支持自定义颜色、尺寸、圆角等多种样式选项
- 📝 **文字添加** - 可在二维码下方添加自定义文字说明
- 📱 **响应式设计** - 完美适配电脑、平板、手机等各种设备
- ⚡ **快速生成** - 实时预览，一键生成高清二维码
- 💾 **一键下载** - 支持高清PNG格式下载

## 安装与运行

### 环境要求

- Python 3.8+
- pip

### 安装依赖

```bash
pip install -r requirements.txt
```

### 运行应用

```bash
# 方式一：使用main.py
python src/qcode/main.py

# 方式二：直接运行Flask应用
cd src/qcode
python app.py
```

应用将在 `http://localhost:5000` 启动

### 开发模式

```bash
# 安装开发依赖
pip install pytest

# 运行测试
pytest tests/
```

## 项目结构

```
Qcode/
├── src/
│   └── qcode/
│       ├── __init__.py
│       ├── app.py              # Flask应用主文件
│       ├── main.py             # 应用入口点
│       ├── qr_generator.py     # QR码生成核心逻辑
│       ├── templates/
│       │   └── index.html      # 主页面模板
│       └── static/
│           ├── css/
│           │   └── style.css   # 样式文件
│           └── js/
│               └── app.js      # 前端交互逻辑
├── tests/
│   ├── __init__.py
│   └── test_qr_generator.py    # 单元测试
├── requirements.txt            # Python依赖
└── README.md
```

## API接口

### 生成二维码

**POST** `/generate`

请求体：
```json
{
    "data": "二维码内容",
    "size": 300,
    "fill_color": "#000000",
    "back_color": "#FFFFFF",
    "rounded_corners": false,
    "add_text": ""
}
```

响应：
```json
{
    "success": true,
    "qr_code": "data:image/png;base64,...",
    "size": 300
}
```

### 下载二维码

**POST** `/download`

请求体与生成接口相同，返回PNG文件下载。

## 技术栈

- **后端**: Python Flask
- **前端**: HTML5, CSS3, JavaScript (ES6+)
- **QR码生成**: qrcode[pil] 库
- **图像处理**: Pillow
- **样式**: 响应式CSS Grid/Flexbox
- **图标**: Font Awesome

## 开发说明

### 添加新功能

1. 在 `qr_generator.py` 中添加新的QR码生成方法
2. 在 `app.py` 中添加对应的API路由
3. 在前端 `app.js` 中添加交互逻辑
4. 在 `style.css` 中添加对应的样式

### 测试

```bash
# 运行所有测试
pytest tests/

# 运行特定测试文件
pytest tests/test_qr_generator.py

# 生成测试覆盖率报告
pytest --cov=src tests/
```

## 许可证

MIT License

## 贡献

欢迎提交Issue和Pull Request来改进这个项目！