Zunächst sollte ein Python3 Virtualenv erzeugt werden
python3 -m venv venv
source venv/bin/activate
Danach können bei aktiviertem venv alle notwendigen Dependencies mittels
pip install -r requirements.txt
heruntergeladen werden.
Um den Webserver leicht starten zu können liegt ein kleines Shellscript bei, dass alle notwendigen Flask-Umgebungsvariablen aufsetzt und mittels
./run.sh
ausgeführt werden kann. Der Befehl sollte aus dem Wurzelverzeichnis des Repositories ausgeführt werden, kann aber theoretisch von überall verwendet werden. Getest wurde das ganze nur unter Linux mit Bash.
./requirements.txtenthält die Namen aller Abhängigkeiten des Projekts, damit sie schnell installiert werden könnnen./fakedata.pyist ein Script das automatisch eine Datenbank aufsetzt und mit Testdaten befüllt./config.pyenthält die Konfiguration des Flask Applikation./app.pystellt den Einstiegspunkt der Applikation dar und verdrahtet den API-Blueprint, Vue-Frontend und Datenbank miteinander. Konfiguriert die Routen./staticenthält alle JS, CSS und Bildresourcen die von der Applikation verwendet werden sollen../templates/index.htmlenthält das notwendige HTML zum Start der Vue- Applikation und lädt je nach gewähltem Environment die richtige Version von Vue. Wenn die Applikation im DEBUG-Modus läuft wird die Entwicklungs- version von Vue geladen. Andernfalls wird die minifizierte Version verwendet, die für den Einsatz in Produktionsumgebungen geeignet ist../boilerplate.sqliteDatenbank, die durchfakedata.pyerzeugt wurde.
.gitignoreenthält Muster für Ordner und Dateinamen, die nicht versioniert werden sollensetup.cfgenthält Einstellungen für den Pythonlinter flake8 und den Formatter yapf, die etwas längere Zeilen, als von Pep8 gefordert, zulassen