MyUCSpace Documentation Center

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

Working with the development team

• Using Sphinx for building documentation
  • Installation
  • Building the documentation
• MyUCSpace documentation style guide
  • General principles
  • Voice and tone
  • Document structure
  • reStructuredText formatting
  • API documentation
  • Writing for an international audience
  • Grammar and punctuation
  • Terminology and naming
  • File organization
  • Common mistakes to avoid
• Django Backend Development & Design Documentation
  • Document Scope
  • Reading Order
  • Core Roles
  • Module Collaboration
  • Key Flows
  • Documentation Index
  • Module Map
• MyUCSpace - WeChat Mini Program
  • Architecture and Tech Stack
  • Project Structure
  • Core Features and Mechanisms
  • Development and Debugging
  • Development Guidelines
• MyUCSpace - Web
  • Architecture & Tech Stack
  • Project Structure
  • Feature Modules
  • Quick Start
  • Development Configuration
  • Development Conventions
• Classroom digital signage
  • Overview
  • Repository layout
  • How it works
  • Backend API
  • Important behavior changes
  • Building and running
  • Operational notes

API manuals

• Backend API design
  • API Documentation Index
  • 0. Unified Response Format
  • Common Data Structures
• Authentication and user accounts API
  • 1. Login
  • 2. Invite a foreign teacher to register (admin)
  • 3. Email registration (foreign teacher)
  • 4. Get current user information
  • 5. User list (admin)
  • 6. Create user (superadmin / secretary)
  • 7. Update user information (superadmin / secretary)
  • 8. Change role (superadmin)
  • 9. Disable or enable account (superadmin / secretary)
  • 10. Import users from Excel (superadmin / secretary)
  • 11. Refresh token
  • 12. Logout
  • 13. Bind Weixin/WeChat
  • 14. Unbind Weixin/WeChat
  • 15. Get SM2 public key
• Classroom Management API
  • 1. Get Classroom List (Authenticated)
  • 2. Classroom Details
  • 3. Create Classroom (superadmin)
  • 4. Update Classroom Information (superadmin / assistant)
  • 5. Delete Classroom (superadmin)
  • 6. Import Classrooms from Excel (superadmin)
  • 7. Classroom Schedule
  • 8. Get Available Classrooms for the Same Time Slot
• Signage device API
  • 1. Activate a signage device (public, one-time activation code)
  • 2. Current signage device information (device authentication)
  • 3. Current signage device schedule (device authentication)
  • 4. Generate signage binding QR code data (admin)
  • 5. Admin-side signage configuration APIs (admin)
• Courses API
  • 1. Course List (Authenticated)
  • 2. Import Timetable from Excel (superadmin / secretary)
  • 3. Export Timetable (superadmin / secretary)
  • 4. Reschedule a Course Session
• Classroom borrowing workflow API
  • 1. Create a borrowing request
  • 2. Borrowing request list (role-based)
  • 3. Application details
  • 4. Review an application
  • 5. Applicant cancels an application
  • 6. Reschedule a course borrowing (applicant or admin)
• Repair Workflow API
  • Work-Order Status Flow
  • 1. Standard Repair Request (All Authenticated Users)
  • 2. Emergency Repair
  • 3. Work-Order List
  • 4. Update Work Order (assistant / superadmin / counselor)
  • 5. Requester Confirms Repair Completion
• Abuse report API
  • 1. Submit a report (all authenticated users)
  • 2. Report List
  • 3. Handle a Report (superadmin Only)
• Class Check-in API
  • 1. Manually Create a Check-in Session
  • 2. Check-in Session List
  • 3. Get Today’s Check-in Sessions
  • 4. Open a Check-in Session
  • 5. Get Roster
  • 6. Update Student Check-in Status in Real Time
  • 7. Check-in Record List
  • 8. Student View of Daily Courses and Check-in Status
  • 9. Manual Check-in by Teacher
• Audit Log API
  • 1. Get Log List
  • 2. Export CSV
• Common Utilities API
  • 1. Attachment Upload
  • 2. Get System Configuration
  • 3. Set Seasonal Schedule (superadmin Only)
• 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 Log In by Scanning a QR Code 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
• TLS (HTTPS) deployment guide
  • Architecture Overview
  • Files and Paths
  • Prerequisites
  • Certificate Provisioning
  • Nginx TLS Configuration (Current Behavior)
  • Hardening and Production Recommendations
  • Operational Checklist