socialcomputing/coursemapper-webserver-webapp

CourseMapper 镜像文档

镜像概述

CourseMapper是一个协作式课程注释和分析平台，旨在围绕PDF/视频学习材料促进协作与互动，并通过可视化学习分析提供支持。该项目包含多个服务组件，通过Docker容器化部署，方便在不同环境中快速搭建和使用。

核心功能与特性

• 协作课程注释：支持用户对学习材料进行协作注释，促进互动与知识共享
• 多格式学习材料支持：兼容PDF和视频等多种学习资源类型
• 可视化学习分析：提供直观的学习数据分析和可视化展示
• 多服务架构：由webapp、webserver、coursemapper-kg等多个服务组件构成，各组件职责明确
• 容器化部署：支持通过Docker Compose快速部署，简化环境配置

使用场景与适用范围

• 教育机构：用于课程材料的协作标注与分析
• 在线学习平台：增强学习资源的互动性和分析能力
• 课程开发团队：协作开发和优化课程内容
• 研究项目：支持学习行为和资源使用的数据分析

快速开始

在线实例

• 生产环境：coursemapper.soco.inko.cloud（基于最新https://github.com/ude-soco/CourseMapper-webserver/releases%EF%BC%89
• 预览环境：edge.coursemapper.soco.inko.cloud（基于https://github.com/ude-soco/CourseMapper-webserver/tree/main%EF%BC%89

构建与运行

• 使用Docker Compose运行应用：

  bash
  make up
  

• 开发时自动重建（使用Tilt）：

  bash
  make tilt
  

• 使用Docker Compose运行并挂载主机源代码：

  bash
  make mounted
  

• 访问http://localhost:8000/%E5%8D%B3%E5%8F%AF%E4%BD%BF%E7%94%A8%E5%BA%94%E7%94%A8%E3%80%82

应用架构

coursemapper-webserver项目包含以下服务组件，相关镜像托管于Docker Hub：

• proxy：未发布，仅用于无内置HTTP路由的环境
• webapp：https://hub.docker.com/repository/docker/socialcomputing/coursemapper-webserver-webapp/general
• webserver：https://hub.docker.com/repository/docker/socialcomputing/coursemapper-webserver-webserver/general
• coursemapper-kg：https://hub.docker.com/repository/docker/socialcomputing/coursemapper-webserver-coursemapper-kg/general
• MongoDB：https://hub.docker.com/_/mongo

开发环境设置指南

步骤1：前置条件

• 从https://nodejs.org/en/blog/release/v16.14.2%E4%B8%8B%E8%BD%BDNodeJS%EF%BC%88v16.14.2%EF%BC%89
• 从https://www.python.org/downloads/release/python-372/%E4%B8%8B%E8%BD%BDPython%EF%BC%88v3.7.2%EF%BC%89
• 下载https://www.oracle.com/java/technologies/downloads/%E5%B9%B6%E5%AE%89%E8%A3%85
• 下载https://www.jetbrains.com/de-de/idea/download/#section=windows%E6%88%96https://code.visualstudio.com/download%E5%B9%B6%E5%AE%89%E8%A3%85
• 下载https://www.mongodb.com/try/download/community%E5%92%8Chttps://www.mongodb.com/try/download/compass%E5%B9%B6%E5%AE%89%E8%A3%85
• 从https://neo4j.com/download-center/#desktop%E4%B8%8B%E8%BD%BDNeo4j Desktop，安装后启动服务器并登录
• 从https://github.com/tporadowski/redis/releases%E4%B8%8B%E8%BD%BDRedis%E5%B9%B6%E5%AE%89%E8%A3%85
• 下载Elmo包：https://s3-us-west-2.amazonaws.com/allennlp/models/elmo/2x4096_512_2048cnn_2xhighway/elmo_2x4096_512_2048cnn_2xhighway_weights.hdf5%E5%92%8Chttps://uni-duisburg-essen.sciebo.de/s/r4bNsDrkuAkPSfo/download%EF%BC%8C%E5%A4%8D%E5%88%B6%E5%88%B0%60coursemapper-kg/app/algorithms%60%E6%96%87%E4%BB%B6%E5%A4%B9
• 下载https://uni-duisburg-essen.sciebo.de/s/nO06q2wY0t5h8SO%EF%BC%8C%E8%A7%A3%E5%8E%8B%E5%88%B0%60coursemapper-kg/app/algorithms%60%E6%96%87%E4%BB%B6%E5%A4%B9%EF%BC%8C%E7%A1%AE%E4%BF%9D%E6%96%87%E4%BB%B6%E5%A4%B9%E5%90%8D%E7%A7%B0%E4%B8%BA%60stanford-corenlp-full-2018-02-27%60
• 下载https://www.postman.com/downloads/%E5%B9%B6%E5%AE%89%E8%A3%85
• 下载并安装https://desktop.github.com/

步骤2：CourseMapper webserver安装指南

• 在文件资源管理器中进入webserver目录，复制example.env文件并粘贴到同一文件夹，重命名为.env
• 在webserver目录打开命令提示符/终端
• 输入以下命令安装Node包：

  bash
  npm ci
  

  若npm ci命令出现问题，尝试npm install或npm install --force。注意：npm install和npm install --force会删除现有Node包，安装新包并更新package-lock.json文件，请勿将此文件的更改推送到仓库。
• 包安装完成后，输入以下命令运行服务器：

  bash
  npm run watch:dev
  

  服务器将运行在http://localhost:8080
• 按Ctrl + c停止服务器

步骤3：CourseMapper webapp安装指南

• 在webapp目录打开命令提示符/终端
• 输入以下命令安装Angular CLI：

  bash
  npm i -g @angular/cli
  

• 输入以下命令安装Node包：

  bash
  npm ci
  

• 包安装完成后，输入以下命令运行服务器：

  bash
  ng serve
  

  服务器将运行在http://localhost:4200
• 按Ctrl + c停止服务器

步骤4：CourseMapper coursemapper-kg安装指南

• 在文件资源管理器中进入coursemapper-kg目录：
  • 复制example.env文件并粘贴到同一文件夹，重命名为.env。修改环境变量值（NEO4J_USER、NEO4J_PASSWORD、REDIS_PASSWORD）为自定义值。
• 在coursemapper-kg目录打开命令提示符/终端（Windows需管理员权限）
• 安装并激活Windows Python虚拟环境：
  • 安装Python虚拟环境（首次）：

    bash
    pip install pipenv
    

  • 安装Python包（首次）：

    bash
    pipenv install
    

  • 激活虚拟环境（每次启动服务器时）：

    bash
    pipenv shell
    

    （可选）查看Python虚拟环境位置：pipenv --venv
• 下载spacy包（首次）：

  bash
  python -m spacy download en
  

• 进入coursemapper-kg目录，打开终端，依次运行以下命令下载必要的nltk和sentence transformer包（确保已完成步骤1中的7和8）：

  bash
  python -c "import nltk;nltk.download('stopwords'); nltk.download('punkt'); nltk.download('wordnet'); import spacy; spacy.cli.download('en_core_web_sm'); from sentence_transformers import SentenceTransformer; SentenceTransformer('all-mpnet-base-v2'); from flair.embeddings import TransformerDocumentEmbeddings;  TransformerDocumentEmbeddings('sentence-transformers/msmarco-distilbert-base-tas-b'); from app.services.course_materials.kwp_extraction.model import KeyphraseExtractor; KeyphraseExtractor(); KeyphraseExtractor('squeezebert/squeezebert-mnli');"
  

• 运行worker：

  bash
  pipenv run python -m app.worker
  

步骤5：Postman配置

• 打开Postman软件，导入docs文件夹下的CourseMapper.postman_collection.json文件

步骤6：MongoDB Compass配置

• 打开MongoDB Compass，在URI文本框中输入mongodb://localhost:27017，点击连接
• 在左侧面板找到数据库coursemapper_v2