VogelSocialMedia/code/backend/README.md
2025-05-20 09:46:26 +02:00

1.9 KiB

Hier ist deine überarbeitete Dokumentation mit korrigierten Rechtschreibfehlern, konsistenter Formatierung und kleineren stilistischen Verbesserungen:


📦 Verwendete Software

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

▶️ Backend starten

Dieser Befehl startet das Backend, nachdem es korrekt installiert wurde: DB in Docker

yarn start

DB nicht in Docker

yarn start-no-docker

Die Swagger-Dokumentation findest du unter: http://localhost:3000/api-docs


🛠️ Installation

🚀 Installation mit Docker

  1. Docker installieren
  2. Installations-Skript ausführen:
yarn install-script

🧱 Manuelle Installation

1. PostgreSQL installieren

🔹 Windows

PostgreSQL kannst du hier herunterladen: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

🔹 Linux

PostgreSQL über deinen Paketmanager installieren. Danach den Dienst aktivieren:

sudo systemctl enable postgresql --now

2. In eine SQL-Shell wechseln

🔹 Windows
psql
🔹 Linux
sudo -iu postgres psql

3. Benutzer und Datenbank anlegen

In der geöffneten psql-Shell:

CREATE DATABASE prisma;

4. .env-Datei vorbereiten

  • Die Datei .env.example in .env umbenennen
  • Passwort und Token-Secret anpassen

5. Prisma vorbereiten

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

yarn prisma generate

6. Datenbank initialisieren

Dies erstellt die Datenbank anhand der schema.prisma:

yarn prisma migrate dev --name init

Wenn du möchtest, kann ich die Doku auch automatisch auf Englisch übersetzen oder als README.md formatieren. Sag einfach Bescheid!