antonplagemann commented 2 years ago

Jitsi Integrated Musicbot Management Interface (JIMMI) Reloaded

Das Ziel ist es, eine lokale Anwendung zu entwickeln, welche Musik in einen oder mehrere Jitsi-Gespräche streamt. Die Anwendung soll auf dem folgenden Repo basieren: https://github.com/p-fruck/Jimmi

Dieses Projekt hat u. a. noch folgende Mängel:

Keine Tests: Alle aktuellen Projekt-Komponenten sind weder durch Unit-Tests, noch durch Integrations-Tests oder sonstige abgedeckt.
Keine klare Architektur: Der Code folgt dem Hackthon-Ansatz - einfach drauf los gecodet und es läuft schon irgendwie
Zusätzliche Software: So "einfach" das Programm auch wirken soll, so muss der Nutzer zusätzlich noch umständlich ein Add-On manuell installieren, weil der Entwickler nicht doppelt Google-Gebühren bezahlen wollte #FCKG💰💰GL€
Nicht modular: Ein großer Codeblock, keine Wiederverwendbarkeit
Fehlendes Error-Handling: Das Programm besitzt ein mangelhalftes, bis gar kein Error-Management,

Das zu entwickelnde Programm soll diese Mängel möglichst beheben und außerdem noch folgende Zusatzfunktionen bieten:

MUST:

Nutzung von Deno als Backend
Nutzung von Svelte als Frontend
Abspielen von Musik von YouTube in einem Jitsi Call
Steuerung über ein lokales Webinterface
Lokale Anwendung (.exe) welche keine zusätzlichen Plugins benötigt
SHOULD:
Bereitstellen einer REST-API
Steuerung mittels Kommandos im Chat (optional nur für Moderatoren)
CAN:
Abspielen von Musik von SoundCloud
Abspielen von Musik aus einer lokalen Sound-Datei
Abspielen von Musik in verschiedenen Jitsi-Calls
Integration als steuerbare Entity in WorkAdventure

Entwicklungsteam

@tjarbo
@antonplagemann
@p-fruck
@piuswalter
@simon-walz

p-fruck commented 2 years ago

https://github.com/Music-Bot-for-Jitsi

antonplagemann commented 2 years ago

Project Board: https://github.com/orgs/Music-Bot-for-Jitsi/projects/1/views/7

antonplagemann commented 2 years ago

Projekt Details

Projektboard

Das Projektboard besitzt mehrere Ansichten (views):

Eine gute Übersicht über die Änderungshistorie bietet die Ansicht mit Gruppierung nach Iteration (Woche).
Der aktuelle Status für die aktuelle Woche ist über die statusgruppierte Ansicht gut einsehbar.
Eine Übersicht über alle offenen Issues bietet diese Ansicht.

Dokumentation

Hinzugefügt wurde der docs-Ordner, welcher zum jetzigen Stand die folgenden Dateien enthält:

QUICKSTART.md: Eine Anleitung zur einrichtung der Entwicklungsumgebung für den Jimmi Bot
ARCHITECTURE.md: Eine Beschreibung aller verwendeten Module und Frameworks und der eingesetzten Automationen.
CONTRIBUTIONS.md: Übersicht aller Contributions zu anderen Projekten.
DOCKER.md: Anleitung für das Setup mit Docker.

Code

Die Entwicklungsumgebung und Grundstruktur des Repos wurde vollständig eingerichtet (Woche 1 und 2). Aktuell finden noch Arbeiten an der CI/CD statt. Die ersten Features wurden geplant und werden diese Woche begonnen. Eine Übersicht über die für diese Woche geplanten Aktivitäten bietet diese Ansicht des Projektboards.

@p-fruck, @Simon-Walz, @piuswalter, @tjarbo Gerne ergänzen wenn ich was vergessen habe.

@michael-spengler Feedback und Vorschläge sind jederzeit willkommen 💬. Ansonsten machen wir einfach mal so weiter wie aktuell geplant 😊

michael-spengler / cyber-security-software-engineering