socialcomputing/elas-official-backend-3-auth

ELAS 镜像技术文档

一、镜像概述和主要用途

1.1 项目概述

ELAS（Exploratory Learning Analytics toolkit for Students，学生探索性学习分析工具包）是由杜伊斯堡-埃森大学Social Computing Group开发的学习支持平台。该平台旨在为学生提供学习活动支持，整合了由学生主导开发的一系列学习分析（Learning Analytics）应用，是该校Learning Analytics（LA）、Advanced Web Technologies（AWT）及Learning Analytics and Visual Analytics（LAVA）等课程中学生项目成果的集成平台。

1.2 主要用途

• 为学生提供学习数据分析工具，辅助学习过程优化
• 整合多课程学生项目成果，提供多样化学习支持功能
• 作为学习分析技术的实践与展示平台，促进学生间的技术交流与协作

二、核心功能和特性

2.1 核心功能

• 学习分析应用集成：整合课程项目中的优质学习分析工具，覆盖学习行为分析、课程推荐、学习路径规划等场景
• 认证与权限管理：通过backend/3-auth服务提供用户身份认证、权限控制及安全访问管理
• 微服务架构支持：基于服务注册、API网关实现模块化服务部署与扩展
• 多数据源兼容：支持MongoDB（文档数据库）、Neo4j（图数据库）、Redis（缓存）等多种数据存储方案

2.2 技术特性

• 跨技术栈支持：整合Spring Boot（服务注册、API网关）、Django（后端服务）、Node.js（前端、NoteBot服务）等开发框架
• 容器化部署：支持通过Docker Compose快速构建和运行整个平台
• 开发友好：提供完整的本地开发环境配置指南，支持热更新与调试
• 多环境支持：包含生产环境（基于最新release版本）和预览环境（基于main分支）

三、使用场景和适用范围

3.1 适用范围

• 目标用户：杜伊斯堡-埃森大学在校学生
• 部署环境：支持本地开发环境、容器化部署环境及云服务器环境

3.2 典型使用场景

• 学生学习支持：通过集成的学习分析工具跟踪学习进度、获取个性化学习建议
• 课程项目展示：作为学生开发的学习分析应用的统一展示与访问平台
• 教学辅助工具：为教师提供学生学习行为数据可视化支持，辅助教学优化
• 技术开发实践：作为学习微服务架构、多数据库集成及容器化部署的实践平台

四、详细的使用方法和配置说明

4.1 Docker快速部署

4.1.1 环境要求

• Docker Engine（20.10+）
• Docker Compose（v2+）

4.1.2 部署步骤

1. 克隆代码仓库（假设通过Git获取源码）：

   bash
   git clone https://github.com/ude-soco/elas-official.git
   cd elas-official
   

2. 启动服务：

   bash
   docker compose up -d
   

   说明：docker compose up会自动构建并启动所有依赖服务（包括服务注册、API网关、后端微服务、前端及数据库等），默认使用项目根目录下的docker-compose.yml配置。

4.2 开发环境部署（以backend/3-auth服务为例）

4.2.1 环境准备

需预先安装以下软件：

• Python 3.10.10
• pipenv（Python虚拟环境管理工具）
• Git

4.2.2 服务部署步骤

步骤1：获取源码并进入服务目录

bash
git clone https://github.com/ude-soco/elas-official.git
cd elas-official/backend/3-auth

步骤2：配置环境变量

1. 复制环境变量示例文件创建.env：

   bash
   cp example.env .env
   

2. 根据需求修改.env文件（示例配置项包括但不限于数据库连接、密钥、服务端口等，具体参考example.env说明）。

步骤3：设置Python虚拟环境

bash
# 安装pipenv（首次执行）
pip install pipenv

# 安装依赖包（首次执行）
pipenv install

# 激活虚拟环境
pipenv shell

步骤4：数据库迁移

bash
# 创建数据库迁移文件（模型变更时执行）
python manage.py makemigrations

# 应用迁移至数据库
python manage.py migrate

注意：若存在旧数据库文件（如db.sqlite3），建议删除后重新执行迁移命令以确保数据结构一致性。

步骤5：启动服务

bash
python manage.py runserver

服务默认运行在http://localhost:8000（具体端口可通过.env配置调整）。

五、环境变量配置说明

backend/3-auth服务（Django）的核心环境变量通过.env文件配置，需从example.env复制后修改，关键配置项说明如下（具体以实际example.env为准）：

六、技术架构

ELAS采用微服务架构，核心组件包括：

• 服务注册中心（Spring Boot）：管理所有微服务的注册与发现
• API网关（Spring Boot）：统一入口，负责路由、认证与限流
• 后端服务：
  • backend/3-auth：用户认证与权限管理服务（Django）
  • backend/4-e3selector：学习路径选择服务（Django + Celery）
  • backend/5-studycompass：学习指南针与课程推荐服务（Django + Celery）
  • backend/7-notebot：笔记辅助服务（Node.js）
• 前端服务：基于Node.js的Web前端应用
• 数据存储：MongoDB（文档数据）、Neo4j（图数据）、Redis（缓存）、SQLite（关系数据，开发环境）

架构示意图如下：
（原英文文档中架构图路径：assets/elas_technical_architecture.svg，建议部署时参考项目内架构图）

七、实时实例与状态

• 生产环境：elas-official.soco.inko.cloud（基于最新https://github.com/ude-soco/elas-official/releases%EF%BC%89
  状态：!status

• 预览环境：edge.elas-official.soco.inko.cloud（基于main分支）
  状态：!status