Aufpolieren des Projektes

[nickcrisci]

Aufpolieren

@Paul-Johne @sebastianbroc ich habe vor das Projekt mal ein wenig aufzupolieren. Also Refactoring zu betreiben, vielleicht die Dokumentation ein wenig aufzuräumen und mehr. Die Idee dahinter ist, dass wir das Projekt in unser persönliches Portfolio aufnehmen können (falls gewollt).

To-Do

Hier sind ein paar meiner persönlichen Todos, ihr könnt gerne in der Diskussion des Issues noch weitere Punkte hinzufügen.

• [x] Code Linting (z.B. durch ESLint)
• [x] Secrets (z.B. Spotify Client Secret etc...) aus dem Code auslagern
• [ ] Dokumentation verbessern
• [ ] Funktionalität hinzufügen (von uns angedachte Ideen, die wir im Projekt noch nicht umgesetzt hatten)

[nickcrisci]

Ich hab im Commit #3737b1d schonmal ESLint und einige Refactorings vorgenommen. Diese betreffen lediglich den Style des Codes und ändern nichts an der Funktionalität. Dennoch muss der Code auf Funktionalität getestet werden. Seit der Deadline des Projektes könnte sich einiges getan haben, z.B. bezüglich der Spotify API. Daher sollten wir testen, ob das Projekt soweit noch funktioniert, oder ob der Code entsprechend angepasst werden muss. Es wäre sonst peinlich, ein nicht funktionierendes Projekt zu präsentieren.

[nickcrisci]

Ich würde das Repo umbenennen, damit der Name eindeutiger ist. Da wir dieses Repo für das Modul nicht mehr brauchen, sollte das kein Problem sein.

Todo:

• [x] Projekt umbenennen (BeatDrinks)

[nickcrisci]

Ich hatte außerdem überlegt, das Projekt öffentlich zu machen. Ist ja eigentlich eine ganz witzige Idee die wir hatten (finde ich). Vielleicht wird das Projekt so noch ein wenig weiter entwickelt.

Hierzu bräuchte ich dann aber schon mal eure Meinung (@Paul-Johne , @sebastianbroc ).

Todos falls wir das Projekt Open Sourcen:

• [x] Issue Template
• [x] PR Template
• [x] Code of Conduct
• [ ] Contribute.md
• [ ] Lizenz
• [ ] Alles was noch auf Deutsch ist ins Englische übersetzen
• [ ] Doku übersichtlich gestalten
• [ ] Readme.md entsprechend aufbereiten

Die obigen Punkte sind zwar einige, allerdings relativ einfach zu erledigen (zumal es bereits Vorlagen für Code of Conduct etc. gibt).

[Paul-Johne]

Ich habe eben mal kurz durch das Repo geschaut. Wir könnten das Project (classic) namens GDW löschen. Im Wiki wären nur folgende Dateien relevant:

1. Projekt: diverse Konzeptzeichnungen
2. Projekt: Proof-of-Concept Beschreibung
3. Projekt: REST-Schnittstellen-Modellierung

Ich hätte vorgeschlagen, dass im Wiki erst mal nur diese 3 Inhalte behalten. Der "main" Readme würde ich die REST API Funktionen von BeatDrinks schon zuordnen.

[nickcrisci]

Wichtig ist halt vor allem, in welche Richtung das Projekt gehen soll:

• Reine Rest Api
• Anwendung mit Frontend

Je nachdem ergeben sich verschiedene Anforderungen. Ich persönlich bin nicht so scharf darauf ein Frontend zu entwickeln, aber vielleicht ja ihr @sebastianbroc @Paul-Johne

[nickcrisci]

@Paul-Johne ich hab mit dem Commit c987cf8 mal den Zugriff auf die Spotify API umgeschrieben. Kurz zusammengefasst: Ich hab ein wenig Overhead an Code entfernt und die Library für die HTTP Requests von request auf axios umgestellt, da requests mittlerweile deprecated ist und daher für Sicherheitsprobleme sorgt.

Edit: Mit Commit aedd9ee hab ich nun auch einen Cache für den access_token hinzugefügt.

[nickcrisci]

Ich würde, sobald @sebastianbroc hier auch seine Meinung zu gepostet hat, das Issue schließen und den Branch mit dem Main Branch mergen. Die restlichen Dinge die zu tun sind, würde ich dann in einzelnen Issues beschreiben (evtl. dann bereits auf Englisch und mit mehr System) um die Übersicht zu bewahren.

[nickcrisci]

So, hab jetzt alle Dateien mal durchgeguckt und die Dinge die mir direkt aufgefallen sind und die ich auf die schnelle anpassen konnte, angepasst. Diese Änderungen werde ich jetzt erstmal mergen und die Anpassungen die aufwendiger sind in weiteren Issues beschreiben.