# myth-backend

**Repository Path**: jsen/myth-backend

## Basic Information

- **Project Name**: myth-backend
- **Description**: No description available
- **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-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 神话学院管理系统 (Myth Academy Management System)

## 项目简介

神话学院管理系统是一个基于FastAPI框架开发的现代化教务管理系统，旨在为教育机构提供完整的信息化管理解决方案。系统涵盖了学生管理、教师管理、课程管理、班级管理、学年学期管理等核心功能模块，帮助学校实现高效、规范的教务管理。

## 技术栈

- **后端框架**: FastAPI
- **数据库**: MySQL
- **ORM**: SQLAlchemy
- **认证授权**: JWT
- **密码加密**: Bcrypt
- **依赖管理**: Poetry
- **测试框架**: Pytest

## 项目结构

```
myth-backend/
├── app/                    # 应用核心代码
│   ├── api/               # API路由
│   │   └── v1/            # API v1版本
│   ├── config/            # 配置文件
│   ├── middleware/        # 中间件
│   ├── models/            # 数据模型
│   ├── schemas/           # Pydantic模型/数据验证
│   ├── utils/             # 工具类
│   └── main.py            # 应用入口
├── design/                # 设计文档
├── logs/                  # 日志文件
├── scripts/               # 脚本文件
├── tests/                 # 测试文件
├── .env.example           # 环境变量示例
├── .gitignore             # Git忽略文件
├── README.md              # 项目说明文档
├── poetry.lock            # Poetry依赖锁文件
├── pyproject.toml         # Poetry项目配置
└── run.py                 # 应用启动文件
```

## 功能模块

### 1. 用户管理 (Users)
- 用户注册、登录、登出
- 用户信息查看与修改
- 密码修改功能
- 用户状态管理

### 2. 角色权限管理 (Roles & Permissions)
- 角色创建、查看、修改、删除
- 权限创建、查看、修改、删除
- 用户角色分配
- 角色权限分配

### 3. 学生管理 (Students)
- 学生信息录入与维护
- 学籍状态管理
- 学生信息查询

### 4. 教师管理 (Teachers)
- 教师信息管理
- 教师资质信息维护
- 教师信息查询

### 5. 教室管理 (Classrooms)
- 教室信息维护
- 教室容量与类型管理
- 教室状态管理

### 6. 课程管理 (Courses)
- 课程信息管理
- 课程类型与学分设置
- 适用年级范围设定

### 7. 学年学期管理 (Academic Years)
- 学年学期设置
- 学期起止时间管理
- 当前学年标记

### 8. 班级管理 (Classes)
- 班级创建与维护
- 班主任指定
- 班级学生数量管理

### 9. 班级学生管理 (Class Students)
- 班级学生分配
- 学生班级调整
- 班级学生关系维护

## API接口文档

系统提供完整的RESTful API接口，可通过以下地址访问API文档：

- Swagger UI: `http://localhost:8000/docs`
- ReDoc: `http://localhost:8000/redoc`

## 环境要求

- Python 3.12+
- MySQL 5.7+
- Poetry (依赖管理)

## 安装与运行

### 1. 克隆项目

```bash
git clone https://gitee.com/jsen/myth-backend.git
cd myth-backend
```

### 2. 安装依赖

```bash
poetry install
```

### 3. 配置环境变量

复制 `.env.example` 文件为 `.env` 并根据实际情况修改配置：

```bash
cp .env.example .env
```

### 4. 数据库初始化

```bash
# 创建数据库表结构
python scripts/init_db.py

# 初始化角色和用户数据
python scripts/init_roles_users.py
```

### 5. 启动应用

```bash
python run.py
```

应用默认运行在 `http://localhost:8000`

## 测试

运行测试用例：

```bash
poetry run pytest
```

## 脚本工具

项目提供了一些实用的脚本工具：

- `scripts/init_db.py`: 初始化数据库表结构
- `scripts/init_roles_users.py`: 初始化角色和用户数据
- `scripts/apifox_curl_test.sh`: API接口测试脚本
- `scripts/apifox_test_script.js`: Node.js版本API测试脚本

## 开发规范

- 遵循阿里开发规范
- 使用Pydantic进行数据验证
- 统一响应格式
- 完整的日志记录
- 异常统一处理

## 许可证

[MIT License](LICENSE)