Der Chatbot "GreenAssistant" gibt praktische Tipps für einen nachhaltigeren Alltag und vermittelt dabei die spezifischen Nachhaltigkeitsziele Augsburgs. Mithilfe modernster KI-Technologien werden Nutzerfragen individuell und präzise beantwortet. Dieses innovative Open-Source-Projekt macht nachhaltiges Handeln für alle zugänglich.
- LIZENZ DATEI
- Wir freuen uns über die Nennung der Originalautoren beim Kopieren, Verwenden oder Umschreiben des Quellcodes.
- Kommentare, Fragen und allgemeines Feedback können gerne an folgende E-Mail-Adresse gesendet werden: [email protected]
- Bei dem Projekt handelte es sich initial um ein studiengangsübergreifendes Semesterprojekt an der Technischen Hochschule Augsburg.
-
Studenten/Studentinnen: Marc Fischer, Manuel Hagen, Lukas Konietzka, Theresa Mayer, Dominik Wegner, Stephan Schorer, Kim Yen Pham, Markus Riffel, Lara Gerlach, Trang Nguyen
-
Beteiligte: Büro f. Nachhaltigkeit der Stadt Augsburg
-
Supervision: Prof. Dr. Anja Metzner (Technische Hochschule Augsburg)
Vielen Dank an alle Beteiligten!
Wir hatten am Projekttag den Chatbot in einer VM gehostet, die folgende Hardwarekonfiguration hatte:
- CPU (8 Kerne)
- GPU (16 GB VRAM)
- RAM (32 GB)
- Storage (256GB)
Wichtig! Dies sind nur Richtwerte. Es gibt zahlreiche weitere Einflussfaktoren, welche die Performance beeinträchtigen könnten, was sich in einer langsameren Antwortzeit äußert.
- Als Erstes müssen die nötigen Tools installiert werden:
- python → https://www.python.org/downloads/
- node.js → https://nodejs.org/en/download/
- An eine beliebige Stelle navigieren und das Repository über den Button Code per ssh oder https klonen mit:
- vpn zur Hochschule nötig
git clone [repo]
Wenn kein git installiert ist, dann hier einmal herunterladen und installieren: https://git-scm.com/downloads
- Aufsetzen eines virtuellen Environments für Python (kein muss, aber macht Sinn):
- Tool für Virtuelle Environments installieren (ist aber auch schon im requirements.txt):
pip install virtualenv
- In den Prokjektordner wechseln!
- Virtuelles Environment erstellen (env ist der Name des neuen environments, kann auch venv genannt werden):
virtualenv **env**
Dies erstellt einen neuen Ordner env/ im Projekt (nicht ins repo pushen, dieser wird von git ignoriert!).
- Virtuelles Environment aktivieren:
source env/Scripts/activate
Auf der Commandline erscheint jetzt ein zusätzlicher Prompt, inetwa so: (env) name@PC
- Um das Environment wieder zu deaktivieren:
~ deactivate
- In den Ordner backend wechseln und alle packages installieren mit:
cd backend
pip install -r requirements.txt
pip install TTS
Mit diesem Befehl werden alle Packages installiert, die in dem File requirements.txt angegeben sind
Achtung: Das Paket TTS ist ganz bewusst nicht im requirements-File, da es ein sehr große Paket ist (10GB). Es muss deshalb separat mit dem pip-Befehl installiert werden. Für das Packet ist eine Installation von Visual Studio nötig. Hier einfach über den Installer das Tool für die Desktopentwicklung installieren und dann den pip-Befehl für das TSS-Paket ausführen. https://visualstudio.microsoft.com/de/downloads/
Sofern dies gegeben ist, kann auch die alternative requirements_full_deployment.txt verwendet werden, dort sind alle optinalen Packete ebenfalls enthalten.
cd backend
pip install -r requirements_full_deployment.txt
- Die Datenbank migrieren mit:
python manage.py migrate
- Dann in den Ordner frontend wechseln und alle Packages installieren mit:
cd frontend
npm install
- Frontend und Backend enthalten jeweils Beispielkonfigurationen, welche auf das eigene Umfeld und Hostingvarianten angepasst werden müssen!
/frontend/src/axios.ts
const baseURL = 'https://greenassistant.ai.tha.de:7000'
/backend/crud/settings.py
DEBUG = False
ALLOWED_HOSTS = [
'greenassistant.ai.tha.de',
'141.82.1.31',
]
SECURE_SSL_REDIRECT = True
CORS_ALLOWED_ORIGINS = [
'http://localhost:3000',
'https://greenassistant.ai.tha.de',
]
CSRF_TRUSTED_ORIGINS = [
'https://greenassistant.ai.tha.de',
'https://greenassistant.ai.tha.de:7000',
]
- Dann eine Zweite Konsole öffnen
- Auf der ersten wechseln wir in den frontend Ordner und starten den Frontend-Server:
cd frontend
npm start
Das Starten des Servers sollte dazu führen, das im Browser eine Website aufgeht
- Auf der anderen Konsole wechseln wir in den backend Ordner und starten den Backend-Server:
cd backend
python manage.py runserver
Für den produktiv Betrieb sollte nicht der Entwicklungsserver von Django verwendet werden. Deshalb ist in der requirements.txt ebenfalls gunicorn enthalten, worüber der Server für den besagten Live Betrieb gestartet werden kann.
cd backend
gunicorn crud.wsgi --timeout 120
Zudem ist es natürlich sinnvoll, dass für den produktiven Betrieb kein Terminal im klassischen Sinn verwendet wird, da dieses terminiert wird, sobald zum Beispiel die IDE geschlossen wird.
Wir haben uns deshalb für das Linux Tool "screen" entschieden, womit Detached Terminal Session erstellt werden können und somit Frontend/Backend weiterläuft auch wenn die IDE geschlossen wird.
- Laufen beide Server ohne Probleme, so kann die Anwendung verwendet und modifiziert werden
- Hier einfach mal ausprobieren, ob man Daten zwischen Frontend und Backend verschicken kann.
- Wurden während der Entwicklung neue Packages installiert, muss die requirements.txt aktualisiert werden. Hierzu einfach folgenden befehle im Ordner backend ausführen:
cd backend
pip freeze > requirements.txt
Es werden jedoch nur Module aufgelistet, die via pip installiert wurden.
