Skip to content
Snippets Groups Projects

README erweitert und example config geändert um Verwirrung zu vermeiden

Merged Felix Baumann requested to merge felixb/videoagwebsite:felix into master
Files
3
+ 17
14
@@ -7,34 +7,37 @@ Hinweis: diese Variante startet eine lokale Testversion der Website, es sind nic
@@ -7,34 +7,37 @@ Hinweis: diese Variante startet eine lokale Testversion der Website, es sind nic
1. Repo Clonen
1. Repo Clonen
2. Verzeichnis betreten
2. Verzeichnis betreten
3. (optional) config.py.example anpassen und als config.py neu speichern
3. (optional) config.py.example anpassen und als config.py neu speichern
(Achtung: per default werden keine Beispieldaten initialisiert und auch kein useraccount
4. Schauen, ob alle Dependencies erfüllt sind (siehe weiter unten)
SQLITE_INIT_DATA sollte also wenigstens beim ersten Durchlauf True sein)
4. Schauen ob alle Dependencies erfüllt sind (siehe weiter unten)
5. `./run.py` ausführen
5. `./run.py` ausführen
6. unter [http://localhost:5000](http://localhost:5000) ist die Website verfügbar
6. Unter [http://localhost:5000](http://localhost:5000) ist die Website verfügbar
7. Moderatorlogin mit user: `videoag` Passwort: `videoag`
7. Moderatorlogin mit user: `videoag` Passwort: `videoag`
### Zum Mitmachen:
### Zum Mitmachen:
1. Repo zum User clonen, dafür den "Clone-Button auf der Website verwenden
1. Repo für den eigenen User forken, dafür den "Fork-Button" auf der Website verwenden
2. Weiter mit 'Zum Testen'
2. Sicherstellen, dass der Upstream richtig konfiguriert ist:
3. Änderungen machen
[Link](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
4. ins eigene Repo pushen
Origin stellt hier euren User da, Upstream das Original der Gruppe videoagwebsite
5. Pull-Request an uns, dazu unter "Merge-Requests" einmal auf "New Merge Request" und das Private Repo auswählen.
3. Erstellt euch eine eigene Branch, diese könnt ihr nennen wie ihr wollt, entweder nach der Änderung oder eurem Namen (git branch username), danach switched ihr in diese Branch (git checkout username)
 
3. Die Initialisierung ist unter "Zum Testen" bereits erklärt worden
 
3. Änderungen machen, committen, upstream mergen (git fetch upstream; git merge upstream/master)
 
4. Ins eigene Repo pushen (git push)
 
5. Pull-Request an uns, dazu unter "Merge-Requests" einmal auf "New Merge Request" und das Private Repo auswählen; oder ihr geht auf euer privates repo, da taucht dann eine Benachrichtigung über einen möglichen Merge-Request auf
6. Warten
6. Warten
7. Wir mergen die Änderungen
7. Wir mergen die Änderungen
### Abhängigkeiten
### Abhängigkeiten
Notwendig:
Notwendig:
* python3
* python3
 
* python3-pip
* flask
* flask
* sqlite
* sqlite
* python-requests (wird vom L2P und vom Kalenderimport verwendet, kann nicht optional eingebunden werden)
* python3-requests (wird vom L2P und vom Kalenderimport verwendet, kann nicht optional eingebunden werden)
Optional (wird für einzelne Features benötigt):
Optional (wird für einzelne Features benötigt):
* python-lxml (Campus Import)
* python3-lxml (Campus Import)
* python-ldap (Login mit Fachschaftsaccount)
* python-ldap (Login mit Fachschaftsaccount)
* python-icalendar (SoGo-Kalenderimport für Sitzungsankündigungen)
* python3-icalendar (SoGo-Kalenderimport für Sitzungsankündigungen)
* python-mysql-connector (wenn MySQL als Datenbank verwendet werden soll)
* mysql-connector (wenn MySQL als Datenbank verwendet werden soll)
Kurzform unter Ubuntu:
Kurzform unter Ubuntu:
sudo apt install python3 python3-pip sqlite python3-requests python3-lxml python-ldap python3-icalendar; pip3 install --upgrade pip; pip3 install Flask python-mysql-connector
sudo apt install python3 python3-pip sqlite python3-requests python3-lxml python-ldap python3-icalendar; pip3 install --upgrade pip; pip3 install Flask mysql-connector
Loading