self host planning poker

Poker à planification auto-hôte

Une application de poker de planification sans tracas à déployer sur votre NAS.

Qu'est-ce que c'est?

Cette application est destinée à une alternative simplifiée et auto-hébercée à la planification du poker en ligne.

Il s'agit de fonctionnalités:

• Plusieurs types de deck: Fibonacci, Fibonacci modifié, tailles de t-shirts, pouvoirs de 2 et vote de confiance (0 à 5)
• Mode spectateur
• Disposition réactive
• Résumé des votes
• Traductions (anglais, français, allemand, italien et polonais. Contributions bienvenue!)

Il n'a pas de fonctionnalités sophistiquées comme la gestion des problèmes, l'intégration Jira ou les minuteries.

Captures d'écran

Déploiement

Le déploiement de l'application est facile car il est autonome dans un seul conteneur. Tout ce dont vous avez besoin est de créer un volume pour persister les paramètres des jeux (ID, nom et deck).

Docker

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

composer docker

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

Variables d'environnement

Variable	Signification	Exemple
APP_ROOT (facultatif)	Vous permet de déployer sur un autre chemin que / . Voir des exemples de configuration pour le déploiement sur les sous-pains pour plus de détails.	APP_ROOT=/poker/

Courir derrière une proxy inversé

Reportez-vous à la documentation de Socket.io pour configurer votre proxy inversé pour fonctionner correctement avec socket.io.

Personnalisation

Voir Personnalisation du style et de l'icône de l'application.

S'impliquer

Je suis développeur et je veux aider

Vous êtes les bienvenus pour ouvrir les demandes de traction de résolution des problèmes dans le projet ou tagué Pr-Welcome. N'oubliez pas de mentionner le problème que vous souhaitez fermer

Je suis un utilisateur et j'ai besoin d'aide / j'ai rencontré un bug / j'ai une demande de fonctionnalité

Ouvrez un problème et je vais y jeter un œil.

Je suis un utilisateur et je veux contribuer des traductions

Il y a un projet Crowdin qui vous permet d'ajouter des traductions pour votre langue. Si votre langue n'est pas disponible, n'hésitez pas à me contacter sur Crowdin.

Développement

L'application se compose de deux parties:

• Un back-end écrit en Python avec Flask, Flask-Socketo et Peewee.
• Un frontal écrit avec Angular et Socket.io.

Développement back-end

Vous devez d'abord initialiser un environnement virtuel et installer les dépendances

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

Le lancement du serveur de développement est ensuite aussi simple que cela:

FLASK_DEBUG=1 python app.py

Exécuter des tests unitaires

Après avoir initialisé l'environnement virtuel, exécutez cette commande dans le flask/ répertoire:

python -m unittest

Développement frontal

Remarque: vous voudrez peut-être tester le front-end contre un back-end. Vous pouvez suivre les instructions de la section précédente pour l'installer et l'exécuter localement ou utiliser la commande suivante pour l'exécuter dans un conteneur Docker:

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 "

Assurez-vous d'abord que Node.js (de préférence LTS) est installé. Ensuite, installez les dépendances et lancez le serveur de développement

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

Image de docker de construction

 # 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