DEFVIS

Server Client Projekt für eine Geodateninfrastruktur DEFVIS im Rahmen des Moduls 4230 und 6230

• Frontend: Next.js, OpenLayers, Three.js und tailwindcss
• Backend: FastAPI, SQLite

GitHub Pages: https://fabianruefenacht.github.io/DEFVIS/

Requirements

• Git
• IDE wie Visual Studio Code
• Anaconda Distribution
• Node.js (Version 20.8.1) und npm (Version 10.1.0) (Node.js und npm herunterladen und installieren)
• Python (Version 3.9.19) (herunterladen)

Repository lokal klonen

Mit Git in einem Terminal das GitHub Repository 6230_FRNMLW in ein lokales Verzeichnis klonen.

cd /path/to/workspace

git clone git@github.com:FabianRuefenacht/6230_FRNMLW.git

Git Projekt mit Visual Studio Code lokal klonen

Öffne ein neues Visual Studio Code Fenster und wähle unter Start Clone Git Repository. Alternativ öffne die Command Palette in VS Code CTRL+Shift+P (View / Command Palette) und wähle Git: clone. Füge die Git web URL https://github.com/FabianRuefenacht/6230_FRNMLW ein und bestätige die Eingabe mit Enter. Wähle einen Ordner in welchen das Repository geklont werden soll.

QuickSetup

Schnellinstallation

Um die Installation und den Start der Web-App zu vereinfachen wurden zwei JavaScirpt-Dateien erstellt, welche die meiste Arbeit abnehmen. Falls die Schnellinstallation fehlschlagen sollte, verwenden Sie bitte die ausführliche Anleitung.

conda create -n defvis python=3.11 pip

conda activate defvis

Installieren der Abhängigkeiten:

node install.js

Schnellstart

conda activate defvis

Front- und Backend starten:

node run.js

Starte im Browser

http://localhost:3000

Ausführliche Installationsanleitung

Frontend installieren

Öffne ein Terminal (Command Prompt in VS Code) und wechsle in den frontend-Ordner in diesem Projekt

1. Verzeichnis öffnen

Öffne die Commandprompt und navigiere in den Ordner frontend

cd frontend

2. Installation der Bibliotheken

npm install

3. Start des Frontends

npm start

4. Vergewissere dich, dass die Web-App läuft

Gebe folgende URL im Webbrowser ein:

http://localhost:3000/

Backend installieren

Öffne ein Terminal und wechsle in den backend-Ordner.

Virtuelle Umgebung für Python mit allen Requirements in der requirements.txt Datei aufsetzen.

1. Verzeichnis öffnen

Öffne die Commandprompt (Anaconda Prompt) und navigieren in den Ordner backend

cd path/to/backend

2. Installation der Python-Bibliotheken

conda create --name defvis python=3.9 --file app/requirements.txt

Backend ausführen, virtuelle Umgebung starten und server starten.

1. In den Ordner backend navigieren

cd backend

2. Conda-environment aktivieren

conda activate defvis

3. Bachend ausführen

python main.py

4. Verifizieren ob das backend läuft. Öffnen Sie im Browser die URL:

http://localhost:8000/docs

API Dokumentation

Fast API kommt mit vorinstallierter Swagger UI. Wenn der Fast API Backen Server läuft, kann auf die Dokumentation der API über Swagger UI auf http://localhost:8000/docs verfügbar.