Skip to content

SchulzeAS/Decisionary

Repository files navigation

Decisionary

Decisionary ist eine NodeJS basierte Entscheidungsfindungswebapplikation.

Informationen zum Projekt

Um den Server zu starten muss der folgende Befehl im Verzeichnis mit der index.js ausgeführt werden.

node index.js --max-http-header-size 65536

Der Server ist unter der Adresse in der config.js konfigurierten Variable "baseUrl" dann im Browser erreichbar.

Installierte npm Pakete

Um alle erforderlichen Pakete zu installieren muss zuvor folgender Befehl ausgeführt werden.

npm ci
  • nodemon (Neustart des Servers bei Änderungen)
  • express (für Views)
  • pug (Template Engine für Express)
  • Browsersync (für Frontend Entwicklung) // startet mit "npm run ui" in neuer Konsole

Konfigurieren der URL

Die URL kann in der Datei config.js ersetzt werden, sofern nicht unter decisionary.ddns.net gearbeitet werden soll. Wenn der Server nur lokal laufen soll, kann http://localhost:8000 verwendet werden. Kein "/" am Ende der URL angeben.

Dokumentation der Skripte

Der Code ist mittels JSDoc dokumentiert. Die Dokumentation ist im Ordner mit dem gleichen Namen zu finden, index.html ist hierbei der Einstiegspunkt. Um JSDoc zu installieren muss lediglich folgender Befehl ausgeführt werde.

npm install -g jsdoc

Führt man jsdoc -r . im root-Verzeichnis aus wird für alle JavaScript-Dateien eine HTML-Seite erstellt. In ./out/index.html ist die Dokumentation zu finden.

About

Lukas, Niklas and me do things for the uni.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages