This repository has been archived on 2024-09-05. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
2024-05-15 16:27:54 +02:00
.gitea added other option for feature request tempalte 2024-05-15 16:27:54 +02:00
scrap Operational documentations 2024-05-13 21:54:13 +02:00
end-user.md Discussed a few more topics 2024-05-15 09:40:34 +02:00
readme.md added server and frontend section 2024-05-15 16:25:30 +02:00

LearningPulse software documentation

Contents

Abstract

go to top

Learning Pulse is an innovative learning platform that blends the strength of Redmenta and Google Classroom to create a collaborative educational environment. The objective is to provide a comprehensive feature package, aiming to incorporate as many elements as possible while maintaining focus on stability. The feature list includes interactive quizzes, dedicated classrooms and assignments, designated study and file-sharing drives for students, and administrator panels.

Feature set

go to top

Classroom

Upon entering the platform this is the first thing students (end-users) will see. A list of classes where the student is enrolled in. These group encore the following features

A list of assignments

Single

Students are assigned assignments by the teacher in this group which they have to fill out by a certain deadline. They can attach any type of document, file or code from their own drive.

Cooperative

These assignments can also be tagged with cooperative tag meaning teachers can assign multiple people to one assignment where they have to work together on one shared project. All students can see their own teammates and open up a chat window to discuss the project.

A list of class documents

Teachers may submit work papers or any other material that students may need to enchant their learning with. These can be document files, programs or any media file. Students can view them straight from the application.

Teacher chat

Students may direct message their teachers inside the class. They can ask for help or link any document from their drive/ the classes documents. They may also attach any kind of media file in that chat window

Quiz

Teachers can create quizzes that students may fill out. This test is server-side only and students may only know the answer upon finishing it. It can also be disabled by the teacher to prevent cheating

Question types

  • Text input

    A basic text input field with a title. A character or word limit can also be set.
    Rewarding:
    Depends. The teacher may give the field a maximum achievable point that user can see when filling out. Then after the test is sent in teachers may grade accordingly.

  • Basic select

    A list of radio buttons are show which only one may be selected.
    Rewarding:
    One point

  • Complex select

    A list of checkboxes are show where multiple (or all) can be selected at once. The creator of the quiz may also create limits on the concurrent selections.
    Rewarding:
    As many points as many good answers.

  • Pair match

    An even number of cards are given that can either be an image or text. Or vise versa.
    The user has to pair these cards. Order does not matter only if they match. Rewarding:
    One point for each right selected pair.

    Rewarding:

    As many points as many good answers.

  • Ordering

    A list of text is show, the user has to order them accordingly.

    Rewarding:

    One point for every correctly ordered card.

File upload(s)

A field where users can select file(s) from their own drive and upload.

Rewarding:

Depends. The teacher may give the field a maximum achievable point that user can see when filling out. Then after the test is sent in teachers may grade accordingly.

Drive

Each user, including teachers will have their own drive where they can upload any kind of file which they may share with other users on the platform. For the sake of less complications S3 storage will be used to build this part of the project.
This feature neatly integrates with the classroom and the quiz part of the program. Students can attach files to quizzes, classwork's from here.
It also allows for collaborative work where users can use fully fledged office suite's to edit their documents inside the browser.

Frontend

The frontend will be built using react as its one of the most popular and stable javascript frameworks out there. The frontend will be 50% client side and 50% SSR using next.js.

Themes

The frontend will allow users to select from a curated list of themes so they can feel right at home. These themes will be made using the following css overrides for Bootstrap:

Server

Backend

The server will be written in Java more precisely SpringBoot. It will be broken down to microservices for easy vertical scaling.
Vertical scaling also allow for redundancy and 99.99% uptime as services can be updated one by one, or updates can be pushed accordingly so that inactive nodes will get the release version and get prioritized. Then older nodes will eventually die off and get updated.

Authentication

For authentication Keycloak will be used to minimize security holes. Each part of the program will be broken down into microservices that later can be deployed using Kubernetes.

Data storage

For storing data PostgreSQL will be used as it is one of the most performant databses out there. For object storage S3 garage will be used as it is geo-located and really easy to deploy.

Load balancing

Kubernetes Load Balancer will be used to distribute load along the nodes.

Staging

In this section the documentation will explain how the application will be built over its lifetime. As this is a massive project, developers need to think thru their decisions on choosing the features and technologies which the application will be built upon. Since LearningPulse will employ many features it's only one way to get started. And that is to start with the bear minimum to get the foundation laying.

Alpha