Interactive Lecture Notes

• About
• Modules
• Testing, Building, Installing
• Deploying on AWS

About

This is a software for an e-learning application specifically designed for university students. The focus is on mathematical content, in particular (logic and model checking).

We currently already support rendering of mathematical content through the KATEX library made by the Khan Academy folks.

Modules

Additional information about this software can be found in the individual modules as well as in the documentation:

• Backend
• Client
• Reverse-Proxy
• Documentation

The backend module handles access to the database and offers REST endpoints for access to the data.

The client module contains all the code for the website that our end users will see.

The reverse-proxy module handles redirection from HTTP to HTTPS and also serves ACME challenges from certbot which run via HTTP.

The documentation contains additional information about this application, including information about the data model and the REST endpoints.

Building, Testing and Installing

Building

To build with maven run the following command from the project root:

mvn package

This will build and package the project including the child modules.

Testing

Integration Test (in particular for the backend module) can be executed with the verify phase:

    mvn verify

The backend integration tests require a properly configured MySQL database to be accessible. By default the tests look for a MySQL database on localhost with port 4001, and expect an existing database named masterylearning that is accessible for user root with password masterylearning. You can override with the spring.datasource.url option:

   mvn verify -Dspring.datasource.url=jdbc:mysql://<db__host>:<db__port>/<db_name>

Replace <db_host>, <db_port> and, db_name by your respective configuration.

We recommend to use Docker to create a MySQL database container for test database with the following command:

    docker run --name masterylearning-mysql-test --net mlnet --net-alias mysql-test -p 4001:3306 \
               --env MYSQL_ROOT_PASSWORD=masterylearning \
               --env MYSQL_DATABASE=masterylearning \
               -d mysql:5.7

Installing

If you want to build the docker images for the application then additionally run the install phase:

mvn install

this will build docker images for all child modules. Running the install phase includes the verify phase which runs integration tests, therefore the above mentioned test database needs to be available.

Deploying to AWS ECR

This section explains how to push the docker images that were built in with Maven to an AWS ERC (e.g. the EC2 Container Registry, which is a Docker registry). The following steps assume that you have installed the aws command line tool.

1. You need to use the aws command to get a login command for docker:

   aws ecr get-login --no-include-email
   

   This will output a docker login command with a very long password, that you can use to login with docker.

2. Use docker tag to tag your images. This step is necessary to let the push command know which images to push:

   docker tag masterylearning/backend:latest <your_ec2registry>/masterylearning/backend
   docker tag masterylearning/client:latest <your_ec2registry>/masterylearning/client
   

3. Finally use docker push to push your images into your docker registry:

   docker push <your_ec2registry>/masterylearning/backend
   docker push <your_ec2registry>/masterylearning/client