How to NK20

Signed-off-by: Yohann D'ANELLO <ynerant@crans.org>
This commit is contained in:
Yohann D'ANELLO 2021-03-21 12:18:45 +01:00
parent 8d8c417c50
commit b7c4360108
Signed by: ynerant
GPG Key ID: 3A75C55819C8CF85
4 changed files with 50 additions and 3 deletions

BIN
docs/_static/img/create_transaction.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

View File

@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------
project = 'Note Kfet 2020'
copyright = '2020, BDE ENS Paris-Saclay'
copyright = '2020-2021, BDE ENS Paris-Saclay'
author = 'BDE ENS Paris-Saclay'
# The full version, including alpha/beta/rc tags

45
docs/getting_started.rst Normal file
View File

@ -0,0 +1,45 @@
La note, c'est quoi ?
=====================
La Note Kfet est un porte-monnaie virtuel proposé gratuitement à tous les adhérents BDE.
C'est le moyen de paiement privilégié au sein du campus, que ce soit pour payer des
activités du BDE, ou bien pour faire des remboursements entre amis. La note contient
également la base d'adhérents du BDE et contient de nombreux outils facilitant la vie
des différents bureaux de clubs, en particulier les trésoriers et surtout les trésoriers
BDE.
La Note Kfet est accessible à l'adresse `<https://note.crans.org>`_. La version actuelle
a été développée par le BDE 2020-2021, et est maintenue par les respos infos du BDE de
l'ENS Paris-Saclay.
Fonctionnement général de la note
---------------------------------
C'est quoi une note ?
~~~~~~~~~~~~~~~~~~~~~
Chaque adhérent⋅e BDE dispose d'un compte appelé « note », créé lors de son adhésion.
Une note est associée à un solde en euros, et à un pseudo appelé « nom de note ».
Le solde associé à la note correspond au solde de l'adhérent⋅e, avec lequel il est
possible de payer tout ce qui est en lien avec le BDE. Le nom de note suffit à
identifier une personne, et il suffit par exemple de donner ce nom à un permanencier
à la Kfet pour acheter un produit.
Faire une transaction
~~~~~~~~~~~~~~~~~~~~~
Tout⋅e adhérent⋅e peut faire une transaction de sa note vers n'importe quelle note
d'un⋅e autre adhérent⋅e, pourvu que le montant de la transaction n'excède pas son
propre solde. Pour cela, il suffit d'aller sur la page de transferts, qui est la
page par défaut après connexion : `<https://note.crans.org/note/transfer/>`_
Le formulaire pour effectuer un transfert apparaît alors. En cliquant sur le bouton
« Je suis l'émetteur », le champ « Émetteurs » est directement complété avec votre
propre note. Il vous suffit alors de remplir le champ « Destinataires » avec le ou
les noms de note que vous voulez créditer, de spécifier le montant et la raison de
votre transfert, puis de cliquer sur le bouton « Virement ». Après quelques secondes,
si votre solde est suffisant et que la transaction est acceptée, un message de
confirmation apparaîtra et la transaction apparaîtra dans l'historique ci-dessous.
.. image:: _static/img/create_transaction.png
:alt: Créer une transaction

View File

@ -2,8 +2,9 @@ Documentation de la Note Kfet 2020
==================================
Bienvenue sur le Wiki de la NoteKfet2020. Ce wiki est plutot orienté vers un public de développeur, qui souhaitent
contribuer au développement, mais expliquent également aux plus curieux comment fonctionne la NoteKfet2020 sous le capot.
Bienvenue sur la documentation de la Note Kfet 2020. Cette documentation est à la fois
destinée aux adhérents BDE pour découvrir le fonctionnement de la note, mais aussi aux
respos info qui souhaitent découvrir comment fonctionne la note sous le capot.
Des informations complémentaires sont également disponibles sur le `Wiki Crans <https://wiki.crans.org/NoteKfet/NoteKfet2020/>`_.
@ -11,6 +12,7 @@ Des informations complémentaires sont également disponibles sur le `Wiki Crans
:maxdepth: 2
:caption: Développement de la NK20
getting_started
apps/index
documentation
faq