VogelSocialMedia/code/backend/README.md
2025-05-12 21:50:50 +02:00

1.5 KiB

📦 Verwendete Software

  • Backend: Node.js
  • Datenbank: PostgreSQL
  • ORM: Prisma

Backend Nutzung

Dieser Command startet das Backend nachdem es korrekt installiert wurde.

yarn start

Die Swagger Doku ist unter /api-docs

🛠️ Installation

1. PostgreSQL installieren

🔹 Windows

PostgreSQL kannst du hier herunterladen.

🔹 Linux

Einfach über den Paketmanager deiner Wahl installieren. Danach den PostgreSQL-Dienst aktivieren (logischischerweise nur wenn du systemd verwendest):

sudo systemctl enable postgresql --now

2. In eine SQL-Shell wechseln

🔹 Windows

Folgenden Befehl ausführen, um als PostgreSQL-Benutzer in die psql-Shell zu gelangen:

psql

🔹 Linux

Folgenden Befehl ausführen, um als PostgreSQL-Benutzer in die psql-Shell zu gelangen:

sudo -iu postgres psql

3. Benutzer und Datenbank in PostgreSQL anlegen

In der geöffneten psql-Shell folgenden Befehl ausführen.

CREATE DATABASE prisma;

4. .env-Datei vorbereiten

Die Datei .env.example in .env umbenennen und dein Passwort dort eintragen. Außerdem solltest du das Token secret ändern.

5. Prisma vorbereiten

Im Projektordner folgenden Befehl ausführen, um Prisma-Client zu generieren:

yarn prisma generate

6. Datenbank initialisieren

Dieser Command erstellt die DB nach der Datei schema.prisma

yarn prisma migrate dev --name init