From 49631fdf64d06fa47a0dd16cff9f813e97e33518 Mon Sep 17 00:00:00 2001
From: canglan <admin@sea-studio.top>
Date: Sat, 4 Apr 2026 01:27:38 +0800
Subject: [PATCH] =?UTF-8?q?=E5=88=9D=E5=A7=8B=E5=8C=96=E6=8F=90=E4=BA=A4?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .env.example |  9 +++++++++
 .gitignore   | 41 +++++++++++++++++++++++++++++++++++++++++
 LICENSE      | 21 +++++++++++++++++++++
 README.md    | 42 ++++++++++++++++++++++++++++++++++++++++--
 4 files changed, 111 insertions(+), 2 deletions(-)
 create mode 100644 .env.example
 create mode 100644 .gitignore
 create mode 100644 LICENSE

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..09f22d4
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,9 @@
+# 数据库配置
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=ClassManagerUser
+DB_PASSWORD=your_secure_password_here
+DB_NAME=ClassManagerDB
+
+# JWT 密钥（32 bytes）
+JWT_SECRET_KEY=your_jwt_secret_key_change_this
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d35c4b5
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,41 @@
+# 环境变量
+.env
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+venv/
+env/
+.venv
+pip-log.txt
+pip-delete-this-directory.txt
+
+# 数据库
+*.db
+*.sqlite
+*.sqlite3
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# 日志
+*.log
+
+# 测试
+.pytest_cache/
+.coverage
+htmlcov/
+
+# 操作系统
+.DS_Store
+Thumbs.db
+
+# 临时文件
+*.tmp
+*.bak
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f863cf0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CangLan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
index 5957865..a6f67a5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
-# 25602ClassManager
+# 班级操行分管理系统
 
-广信息25602班务管理系统
\ No newline at end of file
+基于 Python FastAPI 开发的班级操行分管理系统，支持学生端、管理端、家长端三端访问，实现操行分的加减记录与查询功能。
+
+## 主要功能
+
+### 学生端
+- 查询个人当前操行总分
+- 查看个人加减分历史明细（时间、分数变化、原因）
+- 修改个人登录密码
+- 查看全班学生操行分排行榜
+- 查看任意学生的加减分历史记录
+
+### 管理端（班主任/班委）
+- 对学生进行加分/减分操作（需填写原因）
+- 导出操行分数据（Excel）
+- 批量导入学生
+
+### 家长端
+- 通过学生学号查询子女操行分
+- 查看子女加减分历史明细
+
+## 技术栈
+
+- **后端框架**: FastAPI
+- **数据库**: MySQL
+- **认证**: JWT
+- **配置管理**: python-dotenv（.env）
+
+
+## 安装部署
+
+详见 [INSTALL.md](INSTALL.md)
+
+## 使用说明
+
+详见 [USAGE.md](USAGE.md)
+
+## 许可证
+
+本项目使用[MIT License](LICENSE)许可证
\ No newline at end of file