Skip to content

Commit 1e0a891

Browse files
committed
Update monorepo readme
1 parent c537f17 commit 1e0a891

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

packages/lectureapp/readme.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
33

4-
This package is part of FAILS.
4+
This is main monorepo of FAILS components. (Created as consolidation of the multiple repos used before for FAILS)
5+
56
A web-based system developed out of university lectures.
6-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
7+
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall
8+
including also advanced audio/video transmissions capabilities.
79

810
The students can follow the lecture also on their tablets and notebooks and can scroll independently and ask questions to the lecturer using a chat function.
911
Furthermore, polls can be conducted.
@@ -12,16 +14,20 @@ After the lecture has been completed a pdf can be downloaded at any time.
1214

1315
FAILS components is completely integrated using LTI into LMS such as Moodle.
1416

15-
It is the reincarnation of a system, we were using at our theoretical physics institute for several years. It is was rolled out university wide since a couple of years.
17+
It is the reincarnation of a system, we were using at our theoretical physics institute for several years. FAILS components was rolled out university wide at TU Berlin, since a couple of years.
1618

1719
The system is written with containerization and scalability in mind.
1820

1921
Feedback on errors/issues is appreciated via github's functions.
2022

21-
FAILS is licensed via GNU Affero GPL version 3.0
23+
Most parts of FAILS is licensed via GNU Affero GPL version 3.0.
24+
Some packages have a more permissive license to enable their use outside of FAILS.
25+
26+
## Structure of the minorepo
2227

23-
## Package lectureapp
24-
This package contains the web code for the main notepad app, which runs during the lecture.
28+
* `daemons` includes the source code of the containers running various daemons handling FAILS' backend
29+
* `packages` includes most of the packages FAILS using internally including reusuable components for whiteboarding and for audio and video transmission using Webcodecs and Webtransport.
30+
* `deploy`includes examples directories for deploying the FAILS webapp via Docker compose or Kubernetes using a helm chart.
2531

2632
## Installation
27-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
33+
For installation instructions for a containerized envoironment, please see the `deploy` directory.

0 commit comments

Comments
 (0)