You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.5KB

Votierungstracker

Diese Webapp entwickel ich hauptsächlich für mich selber. Ich möchte gerne eine schnelle, minimale Möglichkeit meine Vortierungen/Vorträge und Punkte in Kursen zu speichern.

Die App soll über https://vote.zottelchin.de erreichbar sein.

Installation

docker run --restart always -d -v "~/.votierungstracker:/db" -p 1234:8900 zottelchin/votierungstracker

Roadmap

User Story Beschreibung
✔️ U01 Server & Login Die Webapp kann über die URL aufgerufen werden, Accounts werden per Secret verwaltet.
✔️ U02 Veranstaltungen Auf dem Startbildschirm sieht man die Veranstaltungen, die der jeweilige Nutzer angelegt hat.
✔️ U03 Votierungen Auf der Seite einer Veranstaltung sieht man den Namen der Veranstaltung, die Punkte sowie die möglichen Punkte. Einträge können hinzugefügt und bearbeitet werden.
✔️ U04 Fortschritt Pro Kurs kann die zu erreichende Prozent-/Punktzahl eingetragen werden; es wird der Fortschritt angezeigt. Milestone 1.0
U05 Sicherheit User-Accounts gebunden an E-Mail-Adresse, Passwortwiederherstellung, Unterstützung von U2F, Security-Header, optionales HTTPS mit Let’s Encrypt. Milestone 1.5

Struktur

Frontend: Vue.js und Milligram ⬍ REST+JSON Backend: Golang mit Gin als Webframework und SQLite für die Datenspeicherung

Einrichtung zur Entwicklung

  1. Benötigte Software: Go & node.js
  2. run Build-Tool installieren: go get github.com/moqmar/run
  3. dep Dependency-Tool installieren: go get github.com/golang/dep/cmd/dep
  4. Code herunterladen: go get github.com/zottelchin/Votierungstracker
  5. Wechsel ins Code-Verzeichnis: cd $GOPATH/src/github.com/zottelchin/Votierungstracker
  6. Frontend-Dependencies installieren: cd frontend && { npm i; cd ..; }
  7. Backend-Dependencies installieren: dep ensure
  8. Programm bauen, starten und bei Dateiänderungen automatisch aktualisieren: run (aktuelles Frontend ist auf [::]:8999 verfügbar, Backend auf [::]:8900) Alternativ: manuell bauen und starten (aktualisiert sich auch bei Dateiänderungen, braucht aber länger bei jedem Build): run manual

Dockercontainer

Um das Docker-Image lokal zu erstellen, sind folgende Schritte notwendig

  1. Benötigte Software: Docker
  2. Repository clonen: git clone github.com/zottelchin/Votierungstracker
  3. Image erstellen lassen: docker build -t zottelchin/votierungstracker .
  4. Container starten: docker run --restart always -d -v "~/.votierungstracker:/db" -p 1234:8900 zottelchin/votierungstracker
  5. Im Browser ist der Votierungstracker jetzt unter localhost:1234 erreichbar