From 995491df394947779c5ba5add8aa916928477a6a Mon Sep 17 00:00:00 2001 From: bytedream Date: Sun, 6 Feb 2022 23:17:03 +0100 Subject: [PATCH] Extended description for new files --- README.txt | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.txt b/README.txt index 23e20f0..dfafa1d 100644 --- a/README.txt +++ b/README.txt @@ -17,6 +17,8 @@ gcc (Einige Go Module haben benötigen C Code der kompiliert werden muss) Wir haben unsere Website auch schon gehostet. Diese ist unter https://bytedream.org/theadversary/ erreichbar. +Um die Website lokal aufzurufen muss die Datei TheAdversary.exe (auf Windows) oder TheAdversary (auf Linux) gestartet +und im Browser http://localhost:8080 aufgerufen werden. Falls du Hilfe benötigst kannst du dich jederzeit an @@ -39,7 +41,7 @@ zeigt diese wird in Echtzeit im Browser mithilfe von WebAssembly (https://de.wik gerendert. Der dahinterliegende Code ist in Rust (https://de.wikipedia.org/wiki/Rust_(Programmiersprache)) geschrieben. Des weiteren entält unsere Website ein Suchfeld um Artikel zu suchen. -Ordnerstruktur: +Datei- / und Ordnerstruktur: MandelbrotWASM: MandelbrotWASM enthält den Source Code für den Mandelbrot Renderer. @@ -52,5 +54,23 @@ frontend: Der /frontend/html/ Ordner enthält die HTML-Dateien. Dateien die mit .gohtml enden sind Templates. Die Dateien about.html, contact.html und legal-notice.html sind statische Dateien. - +.env: + Die Informationen wie der Server laufen soll stehen hier drin. + PORT -> Port auf dem der Server laufen soll. + ADDRESS -> Adresse über die der Server aufgerufen werden soll. + SUBPATH -> (Optionaler) Pfad unter dem Server aufgerufen werden soll. + DATABASE_FILE -> Datenbank in der die Artikel, Autoren und Tags gespeichert werden. + FRONTEND_DIR -> Pfad zum Ordner der das Frontend enthält. + +database.sqlite3: + Die Datenbank die Artikel, Autoren und Tags gespeichert hat. + +Dockerfile: + Eine Dockerfile (https://de.wikipedia.org/wiki/Docker_(Software)) mit der der Server als Docker + Container aufgesetzt werden kann. + Zum Starten auf Linux kann der Folgende Befehl verwendet werden: + >>> docker build -t theadversary . && docker run -p 8080:8080 theadversary + +TheAdversary (Linux) / TheAdversary (Windows): + Das kompilierte Backend aus dem backend/ Ordner.