klaas
/
tkd-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md gefüllt

This commit is contained in:
klaas 2025-03-15 20:12:56 +01:00
parent f54f8d2331
commit b3016c299a
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -6,18 +6,25 @@ Die API basiert auf **Node.js**, **Express** und **PostgreSQL**.
## 🚀 Installation ## 🚀 Installation
1. **Repository klonen:** 1. **Repository klonen:**
```sh ```sh
git clone <REPO-URL> git clone <REPO-URL>
cd trainings-api cd trainings-api
2. **Abhängigkeiten installieren:** 2. **Abhängigkeiten installieren:**
```sh
npm install npm install
3. **Datenbank konfigurieren:** 3. **Datenbank konfigurieren:**
Datei .env aus .env_default erstellen und die PostgreSQL-Verbindungsdaten und Mailzugangsdaten hinterlegen: Datei .env aus .env_default erstellen und die PostgreSQL-Verbindungsdaten und Mailzugangsdaten hinterlegen:
```sh
cp .env_default .env cp .env_default .env
4. **Server starten** 1. **Server starten**
npm start
```sh
npm start
## 📌 API-Endpunkte ## 📌 API-Endpunkte
@ -28,7 +35,6 @@ Alle Endpunkte sind durch JWT gesichert.
requireAuth → Benutzer muss eingeloggt sein. requireAuth → Benutzer muss eingeloggt sein.
requireAdmin → Benutzer benötigt Admin-Rechte. requireAdmin → Benutzer benötigt Admin-Rechte.
### 📋 Mitgliederverwaltung ### 📋 Mitgliederverwaltung
GET /member/:id? GET /member/:id?