https://github.com/freder/teacher.js
https://github.com/freder/teacher.js
janus matrix-org outdoors solar-energy teaching-tool
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/freder/teacher.js
- Owner: freder
- Created: 2021-05-20T16:27:46.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-04-06T14:38:22.000Z (almost 4 years ago)
- Last Synced: 2024-01-30T12:53:50.206Z (about 2 years ago)
- Topics: janus, matrix-org, outdoors, solar-energy, teaching-tool
- Language: TypeScript
- Homepage:
- Size: 3.23 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# teacher.js
## about
https://teacher.solar/
### additional links
- https://www.digital-future.berlin/en/news/news-in-detail/news/innovation-in-der-hochschullehre-prof-hromada-ausgezeichnet/?tx_news_pi1%5Bcontroller%5D=News&tx_news_pi1%5Baction%5D=detail&cHash=007fe214d60ba674b25ad731c14aa4c4
- https://www.linkedin.com/feed/update/urn%3Ali%3Aactivity%3A6810842214646722560/
## description
the `teacher.js` web application has the following features:
- [matrix](https://matrix.org/) chat (via an embedded [hydrogen](https://github.com/vector-im/hydrogen-web) client)
- collaborative text editing (via an embedded [etherpad lite](https://github.com/ether/etherpad-lite) instance)
- webrtc audio conferencing (using [janus](https://janus.conf.meetecho.com/) + [audiobridge plugin](https://janus.conf.meetecho.com/docs/audiobridge.html))
- synchronization between the client with the _instructor role_ and all other clients via websockets, so that students will always see what the teacher sees:
- [reveal.js](https://revealjs.com/) presentations
- connected clients are notified about slide changes, etc.
- wikipedia pages
- connected clients are notified about changes (page transitions, jumping to specific sections within the page, etc.)
- recording of teaching sessions (to be replayed at a later time)
- the links to any opened presentation or wikipedia page are automatically be posted to a matrix room
- the audio conference is saved to a file
- relevant events (caused by the presentation / wikipedia module, etc.) are time-stamped and logged to a file on the server
## architecture overview
## conventions
- this repo uses [git-flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
- stable / production branch: `master`
- development / testing branch: `develop`
## setup
install dependencies:
```shell
git clone --recursive teacher.js
cd teacher.js
npm install
cd src/hydrogen
npm install
```
## config
rename `src/.env-example` to `src/.env` and edit according to your needs.
## run
- run server: `DEBUG='T.S:*' npm run server`
- uses https://github.com/visionmedia/debug for logging
- run webpack dev server (client): `npm run dev`
- run hydrogen dev server: `cd src/hydrogen ; npm run start`
- runs on port 3001 by default
then open `http://localhost:8080`.
## build
production build:
```shell
npm run build:prod
```
building hydrogen:
```shell
cd src/hydrogen
npm run build # output will be in src/hydrogen/target
```
## deploy
TODO