Skip to content

Commit d1ab54a

Browse files
committed
Update readme's for new repo structure
1 parent 89c2e7d commit d1ab54a

File tree

20 files changed

+98
-291
lines changed

20 files changed

+98
-291
lines changed

daemons/apphandler/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/apphandler/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/fails-components/apphandler/actions/workflows/docker-publish.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package apphandler
9+
## Daemon apphandler
2510
This package is a node process, that handles the queries from the app inside the LMS.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

daemons/authhandler/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/authhandler/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/fails-components/authhandler/actions/workflows/docker-publish.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
It is the reincarnation of a system, we are using at our theoretical physics institute for several years. Now *initial development* is almost complete, and the software is now rolling out next term university wide.
17-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package authhandler
9+
## Daemon authhandler
2510
This package contains the node server code for authenticating notebooks and screens using a code.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

daemons/avsdispatcher/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/avsdispatcher/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/fails-components/avsdispatcher/actions/workflows/docker-publish.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package avsrouter
9+
## Daemon avsdispatcher
2510
This package contains the node server code for dispatching audio, video, screensharing routers.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

daemons/housekeeping/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/housekeeping/actions/workflows/docker-build.yml/badge.svg)](https://github.com/fails-components/housekeeping/actions/workflows/docker-build.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package notepadhandler
9+
## Daemon notepadhandler
2510
This package contains node server code to handle the notepads and screens during a lecture.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

daemons/ltihandler/readme.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,12 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/ltihandler/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/fails-components/ltihandler/actions/workflows/docker-publish.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package ltihandler
9+
## Daemon ltihandler
2510
This package contains the node server code to handle the requests through LTI.
2611

2712
## Installation

daemons/notepadhandler/readme.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/notepadhandler/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/fails-components/notepadhandler/actions/workflows/docker-publish.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
86

9-
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.
10-
Furthermore, polls can be conducted.
7+
FAILS is licensed via GNU Affero GPL version 3.0
118

12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
21-
22-
FAILS is licensed via GNU Affero GPL version 3.0
23-
24-
## Package security
9+
## Daemon security
2510
This library contains security related code for token verification etc. for various server components of fails.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

daemons/noteshandler/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/noteshandler/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/fails-components/noteshandler/actions/workflows/docker-publish.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package noteshandler
9+
## Daemon noteshandler
2510
This package contains the node server code for handle students attending the lectures.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

daemons/staticserver/readme.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,13 @@
11
!["FAILS logo"](failslogo.svg)
22
# Fancy automated internet lecture system (**FAILS**) - components
3-
[![Publish container](https://github.com/fails-components/staticserver/actions/workflows/docker-build.yml/badge.svg)](https://github.com/fails-components/staticserver/actions/workflows/docker-build.yml)
43

54
This package is part of FAILS.
6-
A web-based system developed out of university lectures.
7-
It is a continuous pen-based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
8-
9-
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.
10-
Furthermore, polls can be conducted.
11-
12-
After the lecture has been completed a pdf can be downloaded at any time.
13-
14-
FAILS components is completely integrated using LTI into LMS such as Moodle.
15-
16-
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-
18-
The system is written with containerization and scalability in mind.
19-
20-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
216

227
FAILS is licensed via GNU Affero GPL version 3.0
238

24-
## Package staticserver
9+
## Daemon staticserver
2510
This code generates the static webpages and generates a container for serving the static assets as well as the user uploaded content.
2611

2712
## Installation
28-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

packages/app/readme.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,12 @@
22
# Fancy automated internet lecture system (**FAILS**) - components
33

44
This package is part of FAILS.
5-
A web based system developed out of university lectures.
6-
Bascially it is a continous pen based notepad editor delivering **electronic chalk** to several beamers in the lecture hall.
7-
8-
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.
9-
Furthermore polls can be conducted.
10-
11-
After the lecture is completed a pdf can be downloaded at anytime.
12-
13-
FAILS components is completely integrated using LTI into LMS such as Moodle.
14-
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.
16-
17-
The system is written with containerization and scalability in mind.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
186

197
FAILS is licensed via GNU Affero GPL version 3.0
208

219
## Package app
2210
This package contains the web code for the app inside the LMS via LTI.
2311

2412
## Installation
25-
For installation instructions for a containerized envoironment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

packages/assets/readme.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,12 @@
22
# Fancy automated internet lecture system (**FAILS**) - components
33

44
This package is part of FAILS.
5-
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-
8-
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.
9-
Furthermore, polls can be conducted.
10-
11-
After the lecture has been completed a pdf can be downloaded at any time.
12-
13-
FAILS components is completely integrated using LTI into LMS such as Moodle.
14-
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.
16-
17-
The system is written with containerization and scalability in mind.
18-
19-
Feedback on errors/issues is appreciated via github's functions.
5+
A web-based system lecture systems developed from the exprience of real university lectures.
206

217
FAILS is licensed via GNU Affero GPL version 3.0
228

239
## Package assets
2410
This package is the library to handle connections to file storage.
2511

2612
## Installation
27-
For installation instructions for a containerized environment, please see the [fails-components/compositions](https://github.com/fails-components/compositions "fails-components/compositions") repository.
13+
For installation instructions for a containerized envoironment, please see the readme and documentation in the main monorepo [fails-components/fancy-lectures](https://github.com/fails-components/fancy-lecture "fails-components/fancy-lecture").

0 commit comments

Comments
 (0)