self host planning poker

SelbstHost-Planungspoker

Eine problemlose Planungspokeranwendung zur Bereitstellung auf Ihrem NAS.

Was ist das?

Diese Anwendung ist als vereinfachte und selbsthostbare Alternative zur Online-Planung von Poker gedacht.

Es enthält:

• Mehrere Decktypen: Fibonacci, modifiziertes Fibonacci, T-Shirt-Größen, 2 und Vertrauensabstimmung (0 bis 5)
• Zuschauermodus
• Responsive Layout
• Abstimmung Zusammenfassung
• Übersetzungen (Englisch, Französisch, Deutsch, Italienisch und Politur. Beiträge willkommen!)

Es gibt keine ausgefallenen Funktionen wie das Problemmanagement, die JIRA -Integration oder die Timer.

Screenshots

Einsatz

Die Bereitstellung der Anwendung ist einfach, da sie in einem einzigen Container in sich geschlossen ist. Alles, was Sie brauchen, ist, ein Volumen zu erstellen, um die Spieleinstellungen (ID, Name und Deck) zu bestehen.

Docker

docker run 
  -v planning-poker-data:/data 
  -p 8000:8000 
  axeleroy/self-host-planning-poker:latest

Docker-Compose

 version : " 3 "
services :
  planning-poker :
    image : axeleroy/self-host-planning-poker:latest
    ports :
      - 8000:8000
    volumes :
      - planning-poker-data:/data
volumes :
  planning-poker-data : {}

Umgebungsvariablen

Variable	Bedeutung	Beispiel
APP_ROOT (optional)	Ermöglicht es Ihnen, sich auf einen anderen Weg als / zu entfernen. Weitere Informationen finden Sie unter Konfigurationsbeispiele für die Bereitstellung auf Subpaths.	APP_ROOT=/poker/

Laufen hinter einer Reverse-Proxy

Siehe Dokumentation von Socket.IO, um Ihr Reverse-Proxy so einzustellen, dass sie korrekt mit Socket.io arbeiten.

Anpassung

Siehe Anpassen des Stils und Symbols der Anwendung.

Sich engagieren

Ich bin Entwickler und möchte helfen

Sie sind herzlich eingeladen, Pull-Anfragen zu öffnen, um Probleme im Projekt zu lösen oder PR-Welcome zu markieren. Vergessen Sie nicht, das Problem zu erwähnen, das Sie schließen möchten

Ich bin ein Benutzer und ich brauche Hilfe / Ich habe einen Fehler gestoßen / ich habe eine Funktionsanforderung

Öffnen Sie ein Problem und ich werde es mir ansehen.

Ich bin ein Benutzer und möchte Übersetzungen beisteuern

Es gibt ein Crowdin -Projekt, mit dem Sie Übersetzungen für Ihre Sprache hinzufügen können. Wenn Ihre Sprache nicht verfügbar ist, können Sie mich gerne über Crowdin kontaktieren.

Entwicklung

Die App besteht aus zwei Teilen:

• Ein Back-End in Python mit Flask, Flask-Socketio und Peewee.
• Ein Front-End mit Angular und Socket.io.

Back-End-Entwicklung

Sie müssen zuerst eine virtuelle Umgebung initialisieren und die Abhängigkeiten installieren

 # Run the following commands in the flask/ folder
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt

Das Starten des Entwicklungsservers ist dann so einfach:

FLASK_DEBUG=1 python app.py

Führen Sie Unit -Tests aus

Führen Sie diesen Befehl nach der Initialisierung der virtuellen Umgebung im flask/ im Verzeichnis aus:

python -m unittest

Front-End-Entwicklung

Hinweis: Möglicherweise möchten Sie das Front-End gegen ein Back-End testen. Sie können entweder die Anweisungen im vorherigen Abschnitt befolgen, um sie lokal zu installieren und auszuführen oder den folgenden Befehl zu verwenden, um sie in einem Docker -Container auszuführen:

docker run --rm -it 
  -v $( pwd ) /flask:/app 
  -p 5000:5000 
  python:3.11-slim 
  bash -c " cd /app; pip install -r requirements.txt; FLASK_DEBUG=1 gunicorn --worker-class eventlet -w 1 app:app --bind 0.0.0.0:5000 "

Stellen Sie zunächst sicher, dass Node.js (vorzugsweise LTS) installiert ist. Installieren Sie dann Abhängigkeiten und starten Sie den Entwicklungsserver

 # Run the following commands in the angular/ folder
npm install
npm start

Bauen von Docker -Bild

 # After checking out the project
docker build . -t axeleroy/self-host-planning-poker:custom
# Alternatively, if you don't want to checkout the project
docker build https://github.com/axeleroy/self-host-planning-poker -t axeleroy/self-host-planning-poker:custom