From 4d62255a23454cd7fd967f2da012a33f2b885ca2 Mon Sep 17 00:00:00 2001 From: Felix Baumann <felixb@fsmpi.rwth-aachen.de> Date: Fri, 14 Oct 2016 20:49:35 +0200 Subject: [PATCH] =?UTF-8?q?README=20erweitert=20und=20example=20config=20g?= =?UTF-8?q?e=C3=A4ndert=20um=20Verwirrung=20zu=20vermeiden?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 27 +++++++++++++++------------ config.py.example | 2 +- 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f9d509d..46e2c9e 100644 --- a/README.md +++ b/README.md @@ -7,33 +7,36 @@ Hinweis: diese Variante startet eine lokale Testversion der Website, es sind nic 1. Repo Clonen 2. Verzeichnis betreten 3. (optional) config.py.example anpassen und als config.py neu speichern -(Achtung: per default werden keine Beispieldaten initialisiert und auch kein useraccount -SQLITE_INIT_DATA sollte also wenigstens beim ersten Durchlauf True sein) -4. Schauen ob alle Dependencies erfüllt sind (siehe weiter unten) +4. Schauen, ob alle Dependencies erfüllt sind (siehe weiter unten) 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` ### Zum Mitmachen: -1. Repo zum User clonen, dafür den "Clone-Button auf der Website verwenden -2. Weiter mit 'Zum Testen' -3. Änderungen machen -4. ins eigene Repo pushen -5. Pull-Request an uns, dazu unter "Merge-Requests" einmal auf "New Merge Request" und das Private Repo auswählen. +1. Repo für den eigenen User forken, dafür den "Fork-Button" auf der Website verwenden +2. Sicherstellen, dass der Upstream richtig konfiguriert ist: +[Link](https://help.github.com/articles/configuring-a-remote-for-a-fork/) +Origin stellt hier euren User da, Upstream das Original der Gruppe videoagwebsite +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 7. Wir mergen die Änderungen ### Abhängigkeiten Notwendig: * python3 +* python3-pip * flask * 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): -* python-lxml (Campus Import) +* python3-lxml (Campus Import) * 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) Kurzform unter Ubuntu: diff --git a/config.py.example b/config.py.example index ec3ed60..672e83b 100644 --- a/config.py.example +++ b/config.py.example @@ -16,7 +16,7 @@ DB_DATA = 'db_example.sql' DB_ENGINE = 'sqlite' SQLITE_DB = 'db.sqlite' SQLITE_INIT_SCHEMA = True -SQLITE_INIT_DATA = False +SQLITE_INIT_DATA = True #LDAP_HOST = 'ldaps://rumo.fsmpi.rwth-aachen.de' #ICAL_URL = 'https://user:password@mail.fsmpi.rwth-aachen.de/SOGo/....ics' -- GitLab