# Classroom Manager - 智慧教室管理系统

[English](./en.md) | 中文

## 项目概述

**智慧教室管理系统（Classroom Manager）** 是面向高校教室与教学资源的数字化管理平台，致力于集中管理教室资源、将预约与使用流程线上化，并为教学场景提供更高效的协作支持。

项目采用前后端解耦架构。Web 端提供基于 **Vue 3 + Element Plus** 的管理与业务操作界面；移动端为 **微信原生小程序**，使用 **TDesign** 便于移动查询与操作；后端基于 **Django** 与 **MySQL**，提供 **REST 风格** 服务与数据支撑。同时，项目结合容器化部署与工程化最佳实践，提升可维护性与可扩展性。

整体上，系统强调一致的设计语言与组件规范，面向 PC 与移动端提供统一的智慧教室管理体验。

## 使用 Docker Compose 快速部署

以下为生产环境部署步骤。**Nginx** 作为反向代理，**Gunicorn** 运行后端服务。

***开发环境请参考 [在开发环境中部署](../ops/development.rst)。***

### 第一步：配置环境变量

根据 `prod.env` 在项目根目录创建 `.env` 文件。

### 第二步：构建并启动

```bash
# 构建并运行
sudo docker compose -f docker-compose.prod.yml up --build -d

# 执行数据库迁移
sudo docker compose -f docker-compose.prod.yml exec backend python manage.py migrate

# 创建管理员账号
sudo docker compose -f docker-compose.prod.yml exec backend python manage.py createsuperuser
```

## 文档（Sphinx）

文档源文件位于 `docs/`，可通过 Docker 在 5000 端口进行热重载预览。

```bash
sudo docker compose up --build sphinx
```

随后打开 `http://localhost:5000`。