LearningPulse/documentation
LearningPulse/documentation
Archived
4
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

extended documentation where it lacked text

Browse source
This commit is contained in:
Seiwy 2024-09-05 13:57:22 +02:00
parent 4435ff7654
commit 80403b98be
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
readme.md
View file

@ -16,9 +16,9 @@ _[go to top](#contents)_
## 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
Upon entering the platform this is the first thing students (end-users) will see. A list of classes where the student is enrolled in. In them, the students will be able to see assginments, comments, posts, and materials uploaded by the teacher.
### A list of assignments
### Assignments
#### Single
@ -28,7 +28,7 @@ Students are assigned assignments by the teacher in this group which they have t
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
### Class documents/materials
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.
@ -110,11 +110,11 @@ It also allows for collaborative work where users can use fully fledged office s
_[go to top](#contents)_
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.
The frontend of the project will be built using React as its one of the most popular and stable Javascript frameworks out there. The frontend will be 50%/50% client and server side rendered using Next.js, not only because of this, but also because of it's high quality and optimization.
## 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:
The frontend will allow users to select from a curated list of themes, making the application highly customizable, while keeping the ease-of-use at high priority, so our users can feel right at home. These themes will be made using the following css overrides for Bootstrap:
- [Windows 95](https://github.com/themesberg/windows-95-ui-kit)
- [Neumorphism](https://demo.themesberg.com/neumorphism-ui/)
@ -153,11 +153,11 @@ For object storage S3 [garage](https://garagehq.deuxfleurs.fr/) will be used con
## Load balancing
Kubernetes Load Balancer will be used to distribute load along the nodes.
With load balancing we wanted to go with something that had high reliability, stability, and also ease-of-use. That is exactly why Kubernetes caught our eye in distributing load along the nodes, meeting every standard point that we had in mind,.
# Versioning
[Semantic versioning](https://semver.org/) will be used to version the software as it is one of the most popular and humanly readable versioning system out there.
[Semantic versioning](https://semver.org/) will be used to version the software, making our life probably 10 times easier as software devs. We chose this, as it is one of the most popular and humanly readable versioning system out there.
> :information_source: **Example**:
> Once someone commits a new update that causes older API's/features to break the [`MAJOR`](https://devhints.io/semver) tag has to be changed accordingly.