README.md

knotnpunkt

Eine Webapp die zur Verwaltung von Stammesmaterial verwendet werden kann. Entwickelt von der DPSG St. Stephanus Beckum

Installation mit Docker

docker run -p 8080:8080 dpsgbeckum/knotnpunkt

Optional: HTTPS aktivieren

docker run --rm -it -p 8080:8080 dpsgbeckum/knotnpunkt --certfile /path/to/cert.pem --keyfile /path/to/key.pem

Optional: Speichern der Datenbankdatei in einem Volume

docker run --rm -it -p 8080:8080 -v knotnpunkt_data:/data knotnpunkt

Docker-Image lokal erstellen:

1. Repository klonen

git clone https://github.com/dpsg-beckum/knotnpunkt.git
cd knotnpunkt

2. Docker-Image erzeugen:

docker build --tag local-knotnpunkt .

3. Docker-Container starten

docker run -p 8080:8080 local-knotnpunkt

Standardbenutzername und Passwort:

Benutzername: admin

Passwort: admin

Funktionen

• Anlegen von Material mit Kategorie, Bild, etc.
• Ausleihen/Auschecken von Material
• Identifikation von Material durch integrierten QR-Code-Scanner
• Einreichen von Kostenbelegen

[WIP] Contributing

• Um zu erfahren, wie du bei knotnpunkt mithelfen kannst, lies bitte in der Datei CONTRIBUTING.md nach
• Um die Entwicker*innenversion zu starten, befolge diese Schritte:

Voraussetzungen:

• Python
• NodeJS + yarn
• Git

1. Repository klonen

git clone https://github.com/dpsg-beckum/knotnpunkt.git
cd knotnpunkt

2. Python-Umgebung vorbereiten (Windows)

python -m venv .venv
.venv/Scripts/activate
pip install -r requirements.txt

2. Python-Umgebung vorbereiten (Linux)

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

3. JavaScript-Bibliotheken installieren

yarn install

5. Flask-Server starten

flask run

Acknowledgements

• flask Framework
• Bootstrap
• fontawesome
• fullcalender
• html5-qrcode
• DPSG

---