# simple-admin-flask

**Repository Path**: simple_admin/simple-admin-flask

## Basic Information

- **Project Name**: simple-admin-flask
- **Description**: 简单的 flask 后台管理系统
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-18
- **Last Updated**: 2025-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# simple admin flask

简单的 flask 后台管理系统

## 代码质量检查

使用 ruff 进行代码质量检查：

```bash
# 自动修复可修复的问题
ruff check . --select I --fix

# 格式化所有 Python 文件
ruff format .
```

## Pre-commit 钩子

项目使用 pre-commit 在提交前自动进行代码检查和格式化：

```bash
# 安装 pre-commit
pip install pre-commit

# 安装 git hooks
pre-commit install

# 手动运行所有钩子
pre-commit run --all-files

# 更新钩子到最新版本
pre-commit autoupdate
```

配置完成后，每次 `git commit` 时会自动运行 ruff 检查和格式化，确保代码质量。

## Commitizen 使用说明

本项目使用 commitizen 来规范 commit message 格式，遵循 Conventional Commits 规范。

### 安装 commitizen

```bash
pip install commitizen
```

### 使用 commitizen 提交代码

```bash
# 使用 commitizen 交互式提交
cz commit

# 或者使用简写
cz c
```

### 中文 Commit Message 类型

- **feat**: ✨ 新功能
- **fix**: 🐛 修复 bug
- **docs**: 📚 文档更新
- **style**: 💎 代码格式化（不影响代码逻辑）
- **refactor**: 📦 代码重构
- **perf**: 🚀 性能优化
- **test**: 🚨 测试相关
- **chore**: 🔧 构建过程或辅助工具的变动
- **ci**: ⚙️ CI/CD 相关
- **build**: 📦 构建系统或外部依赖的变动

### 提交示例

```bash
# 添加新功能
feat: 添加用户登录功能
feat(auth): 添加 JWT 认证

# 修复 bug
fix: 修复用户权限验证问题
fix(api): 修复接口返回数据格式错误

# 更新文档
docs: 更新 API 文档
docs(readme): 完善项目说明
```

### 交互式提交流程

当您运行 `cz commit` 时，系统会依次询问：

1. **选择提交类型**: 从预定义的类型中选择
2. **影响范围**: 可选，如 auth、user、api 等
3. **简短描述**: 必填，简洁描述本次提交
4. **详细描述**: 可选，提供更详细的说明
5. **破坏性变更**: 是否包含不兼容的变更
6. **关联 issue**: 可选，如 #123、#456

### 版本管理

```bash
# 自动生成版本号和 CHANGELOG
cz bump

# 查看当前版本
cz version
```