socialcomputing/elas-official-backend-5-studycompass

ELAS backend/5-studycompass 服务文档

镜像概述和主要用途

backend/5-studycompass服务是"学生探索性学习分析工具包（ELAS）"项目的核心后端服务之一，由杜伊斯堡-埃森大学社会计算小组开发。该服务基于Django框架构建，主要提供StudyCompass（学习指南针）和CourseRecommender（课程推荐）功能，旨在通过学习分析技术支持学生的学习活动，帮助学生更有效地规划学习路径和选择课程。

该服务是ELAS平台的重要组成部分，集成了多个学生项目中开发的学习分析应用，为大学学生提供个性化的学习支持工具。

核心功能和特性

• 学习指南针（StudyCompass）：提供学习进度跟踪、学习计划建议等功能，帮助学生管理学习活动
• 课程推荐（CourseRecommender）：基于学生学习数据和偏好，提供个性化课程推荐
• Django后端架构：采用Python Django框架开发，支持RESTful API接口
• 数据库迁移支持：提供完整的数据库模型迁移机制，确保数据结构更新
• 任务队列处理：集成Celery用于异步任务处理，提高服务响应性能
• 任务监控：支持通过Flower工具监控Celery任务执行状态

使用场景和适用范围

• 目标用户：杜伊斯堡-埃森大学学生
• 应用场景：
  • 学生学习进度跟踪与管理
  • 个性化课程选择与推荐
  • 学习数据分析与可视化支持
• 部署环境：开发环境、测试环境及生产环境（作为ELAS平台一部分）

详细使用方法和配置说明

开发环境准备

前置软件安装

需先安装以下软件：

• OpenJDK 21（Ubuntu/Windows）
• Maven（最新版，Ubuntu/Windows）
• Python（v3.10.10，Ubuntu/Windows）
• Node.js（v18.12.1，Ubuntu/Windows）
• MongoDB Community Server（最新版，含MongoDB Compass，Ubuntu/Windows）
• Neo4j Desktop（v5.12.0，Ubuntu/Windows）
• Git（Ubuntu/Windows）
• Github Desktop（可选，Ubuntu/Windows）
• 代码编辑器（IntelliJ Ultimate或Visual Studio Code，Ubuntu/Windows）
• Postman（Ubuntu/Windows）
• Redis（最新版，Ubuntu/Windows）

Docker部署

快速启动

使用Docker Compose一键部署：

bash
docker compose up

手动部署与配置

环境变量配置

1. 进入服务目录：

   bash
   cd backend/5-studycompass
   

2. 创建环境变量文件：

   • 在该目录下创建.env文件
   • 复制同目录下example.env文件的全部内容到.env中
   • 根据需求修改.env文件中的变量值（可选）

Python虚拟环境设置

1. 安装pipenv（仅首次）：

   bash
   pip install pipenv
   

2. 安装依赖包（仅首次）：

   bash
   pipenv install
   

3. 激活虚拟环境（每次启动服务前）：

   bash
   pipenv shell
   

   可选：查看虚拟环境位置

   bash
   pipenv --venv
   

数据库迁移

1. 创建迁移文件（仅当数据库模型变更时）：

   bash
   python manage.py makemigrations
   

2. 应用迁移：

   bash
   python manage.py migrate
   

   注意：若存在db.sqlite3文件，可删除后重新迁移，迁移仅在数据库模型变更时需要执行

启动服务

bash
python manage.py runserver

Celery任务队列（可选）

在单独终端启动Celery worker：

• Linux或4核以上Windows系统：

  bash
  celery -A server worker --concurrency=4 -l info -P eventlet
  

• 4核以下Windows系统：

  bash
  celery -A server worker -l info -P eventlet
  

Flower任务监控（可选）

bash
flower -A server --port=5555

技术架构

该服务作为ELAS平台的后端组件，与其他服务（如服务注册中心、API网关、认证服务等）协同工作，整体技术架构请参考ELAS项目技术架构图。

相关链接

• ELAS项目官方生产环境：elas-official.soco.inko.cloud
• ELAS项目预览环境：edge.elas-official.soco.inko.cloud