From 5b810bad4ba711f73194387ec5b16cf820d062f4 Mon Sep 17 00:00:00 2001 From: Kai Ritthaler Date: Mon, 12 May 2025 17:38:34 +0200 Subject: [PATCH] changed readme and renamed env.txt => .env.example --- code/backend/{env.txt => .env.example} | 0 code/backend/README.md | 16 ++++++++++++++-- 2 files changed, 14 insertions(+), 2 deletions(-) rename code/backend/{env.txt => .env.example} (100%) diff --git a/code/backend/env.txt b/code/backend/.env.example similarity index 100% rename from code/backend/env.txt rename to code/backend/.env.example diff --git a/code/backend/README.md b/code/backend/README.md index 363cb06..4d4641f 100644 --- a/code/backend/README.md +++ b/code/backend/README.md @@ -6,6 +6,16 @@ --- +## Backend Nutzung + +Dieser Command startet das Backend nachdem es korrekt installiert wurde. + +``` +yarn start +``` + +Die Swagger Doku ist unter [/api-docs](http://localhost:3000/api-docs/) + ## 🛠️ Installation ### 1. PostgreSQL installieren @@ -50,12 +60,14 @@ CREATE DATABASE prisma; ### 4. .env-Datei vorbereiten -Die Datei env.txt in .env umbenennen und dein Passwort dort eintragen. +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: -``` bash +```bash yarn prisma generate ```