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.de (branch main)
• Preview: br-dev.coursemapper.de (branch dev)

Note: Stable releases are currently not running in production.

🐳 Compose

1. Set up .env file (see .env.dist)
2. 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
3. Visit the proxy service on port 8000 to use the application.

🖥️ Application stack

The services making up the coursemapper-webserver application are released as container images, hosted on GitHub Packages. Additional third-party images used:

• MongoDB: mongo (official image)
• Neo4J: neo4j (official image)
• Redis: redis (official image)

🔨 Development Setup Guide

Step by step manual for setting up a development machine running a desktop environment

Step 1: Pre-requisites

• Download NodeJS (v16.14.2) from the official website
• 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
• 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

  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

  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

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

  npm ci

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

  ng serve

  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

See README.md in the coursemapper-kg/concept-map directory and README.md in the coursemapper-kg/recommendation directory for installation instructions.

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