# muffin

**Repository Path**: chenbool/muffin

## Basic Information

- **Project Name**: muffin
- **Description**: No description available
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-10
- **Last Updated**: 2026-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# muffin

#### 介绍

muffin 是一个基于 Python ASGI 框架的轻量级 Web 应用框架，采用 muffin 为核心，集成 tortoise ORM 进行数据库操作，支持 MySQL 数据库、Redis 缓存、会话管理和 JWT 认证。

#### 软件架构

- **核心框架**: muffin (ASGI framework)
- **ORM**: tortoise (数据库 ORM)
- **ASGI 服务器**: uvicorn
- **会话管理**: muffin_session
- **配置管理**: PyYAML
- **数据库**: MySQL
- **缓存**: Redis

#### 项目结构

```
muffin/
├── app/                    # 应用核心目录
│   ├── controller/        # 控制器层
│   │   ├── admin/         # 后台管理模块
│   │   ├── api/           # API 接口模块
│   │   └── index/         # 首页模块
│   ├── model/             # 数据模型
│   │   └── moji.py
│   ├── config.py          # 配置加载
│   └── __init__.py        # 应用初始化
├── util/                   # 工具类
├── config.yaml            # 应用配置文件
├── main.py                # 入口文件
├── requirements.txt       # 依赖列表
└── db.sqlite              # SQLite 数据库文件
```

#### 模块说明

- **index**: 主页模块 (`/`)
- **admin**: 后台管理模块 (`/admin`)
- **api**: API 接口模块 (`/api`)

#### 安装教程

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

2. 配置数据库连接（修改 `config.yaml`）
```yaml
database:
    host: 127.0.0.1
    port: 3306
    user: root
    pass: your_password
    db: your_database
    chartset: utf8mb4
```

3. 启动服务
```bash
python main.py
```

#### 使用说明

1. 访问主页: `http://127.0.0.1:5000/`
2. 后台管理: `http://127.0.0.1:5000/admin`
3. API 接口: `http://127.0.0.1:5000/api`

#### 配置说明

在 `config.yaml` 中可配置以下内容：

- **host**: 服务器监听地址
- **port**: 服务器监听端口
- **debug**: 调试模式开关
- **database**: MySQL 数据库配置
- **session**: 会话管理开关
- **redis**: Redis 缓存配置
- **jwt_secret**: JWT 密钥

#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request