tkd_neu/README.md

61 lines
1.9 KiB
Markdown
Raw Normal View History

2024-09-24 15:56:23 +02:00
# Server README
2024-09-24 15:56:23 +02:00
## Übersicht
Dieser Server ist eine Webanwendung, die mit Node.js und Express.js erstellt wurde. Er bietet eine API für Benutzerregistrierung und -anmeldung sowie eine geschützte Route für autorisierte Benutzer.
2024-09-24 15:56:23 +02:00
Es sollen mehrere Abteilungen abgebildet werden, Mitglieder des Vereins können in mehreren Abteilungen Mitglied sein.
Jede_r Übungsleiter_in hat Zugriff auf die eigene Abteilung und die dazugehörigen Mitglieder und deren Notfallkontakte.
2024-09-24 15:56:23 +02:00
## Zukünftige Funktionen
2024-09-24 15:56:23 +02:00
### Funtionen aus Version 1
2024-09-24 15:56:23 +02:00
- Anwesenheit
- geleitete Spiele
2024-09-24 15:56:50 +02:00
- -Spielewiki
2024-09-24 15:56:23 +02:00
- Riegenzuordnung
2024-09-24 15:56:23 +02:00
### Login für Mitglieder
2024-09-24 15:56:23 +02:00
Mitglieder können ihre eigenen Daten bearbeiten und den eigenen Fortschritt anzeigen.
2024-09-24 15:56:23 +02:00
### Fortschrittsanzeige für Mitglieder
2024-09-24 15:56:23 +02:00
Übungen, die in der Turnstunde geschafft wurden sollen angezeigt werden. So können zum einen Vertretungs-Helfer sehen, wie der Stand der Riege ist, zum anderen können die Kinder zuhause zeigen, was sie geschafft haben.
2024-09-24 15:56:23 +02:00
### installation
2024-09-24 15:56:23 +02:00
Website mit Script zum erstellen der .env Datei sowie der Tabellen und eines Admin-Benutzers.
2024-09-24 15:56:23 +02:00
## Anforderungen
2024-09-24 15:56:23 +02:00
- Node.js (Version 14 oder höher)
- Express.js (Version 4 oder höher)
- PostgreSQL-Datenbank (mit pg-Modul)
2024-09-24 15:56:23 +02:00
## Konfiguration
2024-09-24 15:56:23 +02:00
- Die Datenbankverbindung wird über Umgebungsvariablen konfiguriert (siehe `.env`-Datei).
- Der Server läuft standardmäßig auf Port 3000.
2024-09-24 15:56:23 +02:00
## API-Endpunkte
- `/auth/register`: Registrierung eines neuen Benutzers
- `/auth/login`: Anmeldung eines bestehenden Benutzers
- `/auth/update`: Aktualisierung der Daten eines bestehenden Benutzers
- `/members/all`: Alle Mitglieder einer Abteilung
- `/members/new`: Erstellung eines neuen Mitglieds
## Middleware
- `authenticateToken`: Überprüft den JWT-Token in der Authorization-Header
## Datenbank
- Die Datenbank wird mit dem pg-Modul verbunden.
## Starten des Servers
Die Anwendung kann mit `npm start`, `node server/app.js` oder `nodemon server/app.js` gestartet werden.