Classroom Manager Documentation Center

Welcome to the Classroom Manager documentation center. Please use the sections below to browse by topic.

Quick start

• Classroom Manager - A Smart Classroom Management System
  • Project Overview
  • Quick Deployment with Docker Compose
  • Documentation (Sphinx)
• Classroom Manager - 智慧教室管理系统
  • 项目概述
  • 使用 Docker Compose 快速部署
  • 文档（Sphinx）

Working with the development team

• Software design
  • MySQL 模板
  • 用户组定义
  • 教室借用流程
  • 教室维修需求
  • 人员认证机制
  • 教室调整
  • 人事调整
  • 附加功能
  • 课程表方案（Courses）
  • 课堂签到（Checkins）
• 后端系统说明文档
  • 架构与模块概览
  • 主要业务模块
  • 开发与运维建议
• 智慧教室管理系统 - Web 管理端
  • 架构与技术栈
  • 项目结构
  • 主要功能模块
  • 快速开始
  • 开发配置
  • 开发规范
• Classroom digital signage
  • Overview
  • Repository layout
  • How it works
  • Backend API
  • Building and running
  • Customizing the signage UI

API manuals

• Backend API design
  • 0. 统一返回格式
  • 1. 认证与用户账号
  • 2. 教室管理 API
  • 2.8 课程 API
  • 3. 教室借用流程 API
  • 4. 报修流程 API
  • 5. 举报滥用 API
  • 6. 公共工具 API
  • 7. 常用数据结构（模型）
  • 8. 操作审计日志
  • 9. 课堂签到 API
• Guides for using the SUST API
  • How to read information via SUST API
  • How to write information via SUST API
  • How to SSO via SUST API
  • How to scan a QR code to login in via SUST API

Deployment and maintenance

• Development environment deployment
  • Prerequisites
  • Quick start
  • Access endpoints
  • Development vs production comparison
  • Common commands
  • Reset the environment (remove data volumes)
  • Troubleshooting tips
• Deployment in the production environment
  • Step 1: Configure environment variables
  • Step 2: Build and run
  • Step 3: Initialize the database and create a user
  • Step 4: Configure HTTPS (optional but recommended)
  • Production access endpoints
  • Domestic (China) image mirror configuration
• SSL/TLS (HTTPS) deployment guide
  • Architecture Overview
  • Files and Paths
  • Prerequisites
  • Certificate Provisioning
  • Nginx TLS Configuration (Current Behavior)
  • Hardening and Production Recommendations
  • Operational Checklist

Release notes

• Classroom Manager 0.1.0 release notes
• Classroom Manager 0.1.1 release notes