Als Abschlussprojekt des Moduls Secure Software Engineering sollte diese App mithilfe der Inhalte der Vorlesung so sicher wie möglich gestaltet werden. In der Dokumentation findet man zu jedem Feature die jeweiligen Schutzmechanismen aufgelistet.
In dieser Anwendung haben Nutzer die Möglichkeit, private und öffentliche Notizen zu erstellen. Diese kann man dann in einer Suche suchen und sich anzeigen lassen. Die Notizen können in Markdown oder mit HTML-Tags versehen werden. Unter anderem kann man private Notizen durch das Teilen des Links anderen Nutzern zeigen.
Um das Projekt zu starten führen sie diese Schritte aus:
- Clonen Sie das Repository
- Installieren Sie Docker
- Erstellen Sie ein Konto bei Discord Developers.
- Dort eine "New Application" erstellen
- Unter OAuth2 die CLIENT ID und das CLIENT SECRET in die .env eingeben
- Unter OAuth2 den Redirects angeben http//note.localhost/api/auth/callback/discord
- Danach die restliche .env ausfüllen, Sie können sich an der .env example orientieren und den Kommentaren folgen.
- Wenn das alles erledigt ist, führen sie docker compose up --build aus
- Öffnen Sie die Seite, indem Sie notes.localhost in die Suchleiste des Browsers eingeben
Um an dem Projekt zu arbeiten führen Sie folgende Schritte aus
- Erstellen sie einen neuen Branch feature/Feature
git branch feature/NewFeature - Speichern sie ihre Änderungen, schreiben eine commit Nachricht und pushen sie den Branch
git commit -m "Nachricht"git push