Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thm-mni-ii/feedbacksystem
Intelligent, personalized feedback for students using artificial intelligence
https://github.com/thm-mni-ii/feedbacksystem
digital-learning e-learning education intelligent-tutoring-system its students
Last synced: 3 months ago
JSON representation
Intelligent, personalized feedback for students using artificial intelligence
- Host: GitHub
- URL: https://github.com/thm-mni-ii/feedbacksystem
- Owner: thm-mni-ii
- License: other
- Created: 2018-08-17T12:46:04.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2024-10-29T13:00:09.000Z (3 months ago)
- Last Synced: 2024-10-29T15:54:57.250Z (3 months ago)
- Topics: digital-learning, e-learning, education, intelligent-tutoring-system, its, students
- Language: Scala
- Homepage: https://frits.mni.thm.de/
- Size: 20.6 MB
- Stars: 19
- Watchers: 4
- Forks: 9
- Open Issues: 240
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Feedbacksystem
[](https://opensource.org/licenses/Apache-2.0)
[](https://artifacthub.io/packages/helm/thm-mni-ii/feedbacksystem)
[](https://github.com/thm-mni-ii/feedbacksystem/actions/workflows/ci.yml)
[](https://codecov.io/gh/thm-mni-ii/feedbacksystem)
Intelligent, personalized feedback for students using artificial intelligence
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Security](#security)
- [Vulnerabilities](#vulnerabilities)
- [Background](#background)
- [Install](#install)
- [Development](#development)
- [Production](#production)
- [API](#api)
- [License](#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](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](https://artifacthub.io/packages/helm/thm-mni-ii/feedbacksystem) for more information and an overview of the configuration variables.
#### Requirements
* A Kubernetes Cluster
* [kubectl](https://kubernetes.io/docs/tasks/tools/)
* [helm](https://helm.sh/docs/intro/install/)
* [deno](https://deno.land/manual/getting_started/installation)
#### Steps
1. Ensure the requirements are met
3. Generate values (See [here](https://artifacthub.io/packages/helm/thm-mni-ii/feedbacksystem#script) 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 --create-namespace --wait -f vals.yaml fbs thm-mni-ii/feedbackssystem
```
## API
The specification of the interfaces of the feedbacksystem can be found [here](https://thm-mni-ii.github.io/feedbacksystem/api-docs/).
## License
[Apache-2.0 © 2023 Technischen Hochschule Mittelhessen](LICENSE)