socialcomputing/coursemapper-webserver-webserver repository overview

CourseMapper is a collaborative course annotation and analytics platform that fosters collaboration and interaction around pdf/video learning materials, supported by visual learning analytics.

⁠🚀 Get Started

⁠Live instances

• Production: coursemapper.soco.inko.cloud⁠ (latest release⁠)
• Preview: edge.coursemapper.soco.inko.cloud⁠ (branch main⁠)

⁠Build and run

• make up to run the application using Docker Compose
• make tilt to automatically rebuild during development using Tilt
• make mounted to run processes using Docker Compose, but mount source code from host machine
• see the manual below to install dependencies and run processes locally, without containers

Visit the proxy service on port 8000⁠ to use the application.

⁠🖥️ Application stack

The services making up the coursemapper-webserver project use the following images, hosted on Docker Hub:

• proxy: not published, only required for environments without built-in HTTP routing
• webapp: socialcomputing/coursemapper-webserver-webapp⁠
• webserver: socialcomputing/coursemapper-webserver-webserver⁠
• coursemapper-kg: socialcomputing/coursemapper-webserver-coursemapper-kg⁠
• MongoDB: mongo (official image)⁠

⁠🔨 Development Setup Guide

⁠Step 1: Pre-requisites

• Download NodeJS (v16.14.2) from the official website⁠

• Python (v3.7.2) from the official website⁠

• Download Java JDK 17⁠ and install it

• Download IntelliJ Ultimate⁠ or Visual Studio Code⁠ and install one of the code editors

• Download MongoDB Community Server⁠ and MongoDB Compass⁠ and install them

• Neo4j Desktop from the official website⁠, install it, start the server, and login to the server.

• Redis from the Redis releases page⁠ and install it

• Downlod Elmo packages: Link 1⁠ and Link 2⁠, and copy it inside coursemapper-kg/app/algorithms folder

• Download StanfordCoreNLP⁠ and extract the ZIP file inside coursemapper-kg/app/algorithms folder. Make sure the stanford-corenlp folder name is stanford-corenlp-full-2018-02-27.

• Download Postman⁠ and install it

• Download and install Github Desktop official website⁠

⁠Step 2: Installation Guide for CourseMapper webserver

• Using your file explorer, go inside the directory webserver, copy the example.env file and paste it in the same folder. Rename the copied environment file to .env

• Open a command prompt/terminal in the webserver directory

• Type the command in the command prompt/terminal to install node packages

  npm ci
  

  Copy

  If you face issue with npm ci command, try npm install or npm install --force command. Caution: npm install and npm install --force will delete all the existing node packages, install the new ones and update the package-lock.json file. Please make sure you do not push your changes to the package-lock.json file.

• After the packages are installed, type the following command to run the server

  npm run watch:dev
  

  Copy

  The server will run at http://localhost:8080⁠

• Stop the server by pressing Cntl + c inside the command prompt

⁠Step 3: Installation Guide for CourseMapper webapp

• Open a command prompt/terminal in the webapp directory

• Type the command in the command prompt/terminal to install the Angular CLI

  npm i -g @angular/cli
  

  Copy

• Type the command in the command prompt/terminal to install node packages

  npm ci
  

  Copy

• After the packages are installed, type the following command to run the server

  ng serve
  

  Copy

  The server will run at http://localhost:4200⁠

• Stop the server by pressing Cntl + c inside the command prompt

⁠Step 4: Installation Guide for CourseMapper coursemapper-kg

• Using your file explorer, go inside the directory coursemapper-kg

  • Copy the example.env file and paste it in the same folder. Rename the copied environment file to .env. Change the values (NEO4J_USER, NEO4J_PASSWORD, REDIS_PASSWORD) of the environment variables in the .env file to your own values.

• Open a command prompt/terminal in the coursemapper-kg directory (with administration rights for Windows)

• Install and activate python virtual environment for Windows

  • Type the following commands to install and activate the virtual environment:

    • Install python virtual environment (only first time)

      pip install pipenv
      

      Copy

    • Install python package (only first time)

      pipenv install
      

      Copy

    • Activate the virtual environment (every time when you want to start the server)

      pipenv shell
      

      Copy

      (Optional) To check the location of your Python virtual environment, type pipenv --venv the following command in your command prompt

• Download the spacy package (only first time)

  python -m spacy download en
  

  Copy

• Move to the directory coursemapper-kg, open a terminal, copy the codes below and paste it in the terminal one at a time to download the necessary nltk and sentence transformer packages.

  Make sure that you have downloaded the models from number 7 and 8 from step 1 above.

  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');"
  

  Copy

• Run the worker

  pipenv run python -m app.worker
  

  Copy

⁠Step 5: Postman configuration

• Open the Postman software and import the file CourseMapper.postman_collection.json found under docs folder

⁠Step 6: MongoDB Compass configuration

• Open MongoDB Compass and type mongodb://localhost:27017 in the URI textbox and press connect button
• Find the database coursemapper_v2 in the left panel