thm-mni-ii / feedbacksystem

Intelligent, personalized feedback for students using artificial intelligence

Feedbacksystem

Intelligent, personalized feedback for students using artificial intelligence

Table of Contents

• Table of Contents
• Security
  • Vulnerabilities
• Background
• Install
  • Development
  • Production
• API
• License

Security

Vulnerabilities

If you find a vulnerability in this system, please report it at the following url:

https://github.com/thm-mni-ii/feedbacksystem/security/advisories/new

Background

As a student you have to submit a lot of tasks for your lectures. Usually the only reply you get is that you passed or failed. This is a situation we want to change. Feedbacksystem is an application to automatically check your submissions and give an immediate result. With the result we want to provide suggestions to the students about their mistakes, collect the most common mistakes and present them to the lecturers such that they can address them in the lectures.

Install

Development

The following software is required for the development:

• Java (Version 11)
• Docker
• Git

Clone this Repository to your locale Directory

git clone [email protected]:thm-mni-ii/feedbacksystem.git

Change to the cloned directory

cd feedbacksystem

Build all container an start them with docker compose

docker compose up -d --build

The System can now be accessed at https://localhost.

Frontend

For frontend development the following software is needed:

• node
• npm

Change to the Directory of the frontend code

cd modules/fbs-core/web

Install neccessary npm packages and start the dev-server

npm i
npm run start

Production

Note
See here for more information and an overview of the configuration variables.

Requirements

• A Kubernetes Cluster
• kubectl
• helm
• deno

Steps

1. Ensure the requirements are met
2. Generate values (See here for details)

deno run --reload=https://raw.githubusercontent.com --allow-write=vals.yaml https://raw.githubusercontent.com/thm-mni-ii/helm-charts/main/charts/feedbacksystem/generate-values.ts vals.yaml

4. Add the helm repository

helm repo add thm-mni-ii https://thm-mni-ii.github.io/helm-charts

5. Install

helm install -n <namepsace> --create-namespace --wait -f vals.yaml fbs thm-mni-ii/feedbackssystem

API

The specification of the interfaces of the feedbacksystem can be found here.

License

Apache-2.0 © 2023 Technischen Hochschule Mittelhessen

feedbacksystem's Issues

get more Detail Information from CAS

Until now CAS returns only the Username, which is very boring.

Implement a role-system

Following Roles should exists:
Admin
Student
Dozent
Hiwi

• User can assigned to edit / own courses
• Grant user for a course POST /api/v1/courses/{id}/grant {username:username,grant_type:edit}

Add PHP/Python Support for Secret Token Checker

Code Fragments to manage Archives

We need to compress and uncompress Archives like zip, tar.gz and jar.
(see plexus-archive)

Manage User logins

• All logins should be registrated
• create route to see last logins of everyone
• only admin can access this
• filter users by his last login

Page: Display Plagiarism

We need a page that shows the plagiarism results.

Page: Lecture Search

Site for searching for Lectures and adding them to private lecture list

Implement Testsystems in WS

• Provide Route to create, edit, get, delete information about a feedback-testinstance (Port, topic / short_name, description and more)
• link feedback-testinstance to a task, i.e. update create / update tasks
• save/get informations in a .yaml file
• document changes in WIKI
• document Kafka Exchange Format in WIKI
• get all system should be possible if user has at least one docent access

Database Service

Service for managing database in Angular

Run secrettokenchecker in docker

Page: Admin Site

Creating a site for administrative purpose.

Page: Display Results And Analyse Data

We need an angular2 page to display the JUnit results.

Add a Stylechecker

To get consistent code, add a stylechecker and run it during the build process.

http://www.scalastyle.org looks to be the standard in Scala projects.

Projekt Module for SQL Checker

Create a new module for the SQL Checker.

Lecturer: Create / Manage Task

We need a page to create and manage tasks.

get JAVA CAS client running

Using the official CAS Client https://github.com/apereo/java-cas-client and try to let it run with / inside the THM Network.

Code Fragment for Executing JUnit Tests

We need a strategy how to execute JUnit Tests, and how to get the tests results.

Adjust file upload in Task creation and submission

Hi @Phpp1010 I already implemented, but not yet merged in master, a file upload option while creating or submit a task. Currenty, a base64 String and a filename musst be send to the REST. An other option would be an extra Multipart Upload REST or another byte format to put this in the JSON Request.

What do you think is best idea?

Page: Create / Manage Lecture

We need a form to create and manage a lecture.

Projekt Module for Signature Checker

Create a new project module for the signature checker.

Send bash file with kafka to docker

We need to provide test file (i.e. bash files) in our Webservice. Then we can send these URLs to a running docker instance.

Rewrite /task to /course/task

• simple rename this existing routes after discussion
• edi Wiki with updated information

Serve Angular2 App via Spring Boot

Currently we have no http server to serve the angular2 app.

after Rework WS no index.html

After we reworked WS, the index.html is not longer reachable.

Page: Submit Solution Form

We need an angular2 page that allows us to upload solutions.

Authentication service for angular

Service in angular to manage the database

REST Courses / Tasks

• submit Task saves also submitted Data
• POST /api/v1/courses/:id/unsubscribe
• DELETE /api/v1/courses/:id
• rewrite GET /api/v1/courses/:id with all tasks, if user is subscribed
• PUT /api/v1/courses/:id
• rewrite GET /api/v1/courses/
• GET /api/v1/courses/all for searching
• implement a application config to generate long term jwt keys
• Add Task: POST: /api/v1/courses/{id}/tasks (including a test file!)
• rewrite and fix submit Task
• PUT /api/v1/tasks/:id
• DELETE /api/v1/tasks/:id

Page: StudentCourseData

Show subscribed courses of an user

Projekt Module for Plagiarism Checker

Add a project module for the plagiarism checker.

Angular Material

Add angular material to the angular2 app.

Rewrite REST routines for accepting JSON Parameters and

Write new test route for login to get a key by user string

For development purpose

Code Fragment to execute bash scripts.

We need to find out how to execute bash scripts.

Create concept for sending big files via kafka

If test files are about 100's of MB, how to send them with kafka.

Page: Display Tasks

We need a page to display all the tasks available.

Page: Login and Logout

We need a login / logout page. The logout page is the page that the user should see after he logout. It may be the login page with a message that the user logged out successfully.

REST: Users / Roles

• Stammdaten des Benutzers / Angeben / Route NUR für den Benutzer ansehen! --> Floskel "Zusätzlich zu den Stammdaten gibt es die Abgeben der Tests"
• DELETE users/ --> BATCH!! --> Festlegen können, Abgaben des Benutzer mitlöschen oder nicht
• users/last/login/after/{}/before/{} , update to get more filters
• rewrite roles logic
• a docent for one course can grant tutor to other course
• every user is a student
• moderator can create courses
• moderator can grant a user as docent for one courses
• admin can manage user roles
• admin can grant moderator
• admin can delete users
• admin can delete inactive users see #72
• docent can manage his courses, edit, create tasks, delete tasks ...
• Grant roles to user PUT /api/v1/users/{id}/role if one has rights to do it
• update routes in WIKI

Plagiarism Check

We need tools that helps us to detect plagiarism among the submissions / solutions.

API: Implement route for _users_

Implement the users POST and GET routing for a first test and interaction with frontend. Use mySQL Database. Also write a simple Login

reimplement #44 and #45 with new Scala syntax

We need to reimplement both branches, with the new DB-Object, and so forth.

Format for JUnit Results

We require a format for the JUnit Results. We could represent them as JSON.

Set JWT with Expiration date and accept token from Request Header

Page: Lecture List

We need a page that displays all the lectures available.

Implement REST routes for course and task creating / overview

• Create course POST: /api/v1/courses
• See task to course GET: /api/v1/courses/{id}
• User subscribe course: POST: /api/v1/courses/{id}/subscribe
• User see all subscribed courses: GET: /api/v1/courses/
• As Dozent: See submissions: /api/v1/courses/{id}/submissions
  Depends on Role System which has to be implement, too

Implement REST for user to see summary of all submissions

A Summary Overview of all Submissions, of all Task of all Courses, ordered by submission date

Application for running bash scripts

Also add communication via kafka to receive arguments and send output of the script

Automatic Build Process

Add a travis build script to build and tests the artefacts.

Page: Design

Design for Angular app

Implement first prototype

• Use JSON Serializing / Deserializing in Kafka Communication
• Refactor JSON Serializing / Deserializing in Kafka Communication
• Use JWT Token with expiration date
• Create / Set UP DB to Save Courses
• If user submit a task send error code 20X
• API should listen on incoming Kafka answers and save it to DB
• show results to submissions for a specific course

Page: Create / Manage Submission / Solution

We need a page to create and manage a submission.