README.md gefüllt
This commit is contained in:
parent
6c6c716e06
commit
26faf13fe6
11
README.md
11
README.md
|
@ -10,21 +10,26 @@ Die API basiert auf **Node.js**, **Express** und **PostgreSQL**.
|
||||||
```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
|
```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
|
```sh
|
||||||
cp .env_default .env
|
cp .env_default .env
|
||||||
|
```
|
||||||
|
|
||||||
1. **Server starten**
|
1. **Server starten**
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm start
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
## 📌 API-Endpunkte
|
## 📌 API-Endpunkte
|
||||||
|
|
||||||
|
@ -87,8 +92,10 @@ Authentifizierung: JWT
|
||||||
|
|
||||||
### 📜 Linter & Formatierung
|
### 📜 Linter & Formatierung
|
||||||
|
|
||||||
npm run lint
|
```sh
|
||||||
npm run format
|
npm run lint
|
||||||
|
npm run format
|
||||||
|
```
|
||||||
|
|
||||||
### 📦 Abhängigkeiten aktualisieren
|
### 📦 Abhängigkeiten aktualisieren
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue