mirror of
				https://gitlab.crans.org/bde/nk20
				synced 2025-11-04 09:12:11 +01:00 
			
		
		
		
	@@ -28,13 +28,13 @@ Il suffit d'ajouter le préfixe ``/api/`` pour arriver sur ces pages.
 | 
			
		||||
* `members/club <member#club>`_ : liste des différents clubs enregistrés
 | 
			
		||||
* `members/membership <member#adhesion>`_ : liste des adhésions enregistrées
 | 
			
		||||
* `activity/activity <activity#activite>`_ : liste des activités recensées
 | 
			
		||||
* `activity/type <activity#type-d-activite>`_ : liste des différents types d'activités : pots, soirées de club, ...
 | 
			
		||||
* `activity/type <activity#type-d-activite>`_ : liste des différents types d'activités : pots, soirées de club,…
 | 
			
		||||
* `activity/guest <activity#invite>`_ : liste des personnes invitées lors d'une activité
 | 
			
		||||
* `activity/entry <activity#entree>`_ : liste des entrées effectuées lors des activités
 | 
			
		||||
* `note/note <note#note>`_ : liste des notes enregistrées
 | 
			
		||||
* `note/alias <note#alias>`_ : liste des alias enregistrés
 | 
			
		||||
* `note/consumer <note#consommateur>`_ : liste des alias enregistrés avec leur note associée
 | 
			
		||||
* `note/transaction/category <note#categorie-de-transaction>`_ : liste des différentes catégories de boutons : soft, alcool, ...
 | 
			
		||||
* `note/transaction/category <note#categorie-de-transaction>`_ : liste des différentes catégories de boutons : soft, alcool,…
 | 
			
		||||
* `note/transaction/transaction <note#transaction>`_ : liste des transactions effectuées
 | 
			
		||||
* `note/transaction/template <note#modele-de-transaction>`_ : liste des boutons enregistrés
 | 
			
		||||
* `treasury/invoice <treasury#facture>`_ : liste des factures générées
 | 
			
		||||
@@ -120,7 +120,7 @@ POST
 | 
			
		||||
~~~~
 | 
			
		||||
 | 
			
		||||
Une requête POST permet d'ajouter des éléments. Cette requête n'est possible que sur la page ``/api/<model>/``,
 | 
			
		||||
la requête POST n'est pas supportée sur les pages de détails (car cette requête permet ... l'ajout).
 | 
			
		||||
la requête POST n'est pas supportée sur les pages de détails (car cette requête permet… l'ajout).
 | 
			
		||||
 | 
			
		||||
Des exceptions sont faites sur certaines pages : les pages de logs et de contenttypes sont en lecture uniquement.
 | 
			
		||||
 | 
			
		||||
@@ -205,10 +205,10 @@ Une reqête OPTIONS affiche l'ensemble des opérations possibles sur un modèle
 | 
			
		||||
 | 
			
		||||
* ``<METHOD>`` est le type de requête HTTP supporté (pour modification, inclus dans {``POST``, ``PUT``, ``PATCH``}).
 | 
			
		||||
* ``<FIELD_NAME>`` est le nom du champ dans le modèle concerné (exemple : ``id``)
 | 
			
		||||
* ``<TYPE>`` représente le type de données : ``integer``, ``string``, ``date``, ``choice``, ``field`` (pour les clés étrangères), ...
 | 
			
		||||
* ``<TYPE>`` représente le type de données : ``integer``, ``string``, ``date``, ``choice``, ``field`` (pour les clés étrangères),…
 | 
			
		||||
* ``<REQUIRED>`` est un booléen indiquant si le champ est requis dans le modèle ou s'il peut être nul/vide.
 | 
			
		||||
* ``<READ_ONLY>`` est un booléen indiquant si le champ est accessible en lecture uniquement.
 | 
			
		||||
* ``<LABEL>`` représente le label du champ, son nom traduit, qui s'affiche dans le formulaire accessible sur l'API Web.
 | 
			
		||||
 | 
			
		||||
Des contraintes peuvent s'ajouter à cela selon les champs : taille maximale de chaînes de caractères, valeurs minimales
 | 
			
		||||
et maximales pour les entiers ...
 | 
			
		||||
et maximales pour les entiers…
 | 
			
		||||
@@ -13,7 +13,7 @@ L'application comporte 5 modèles : activités, types d'activité, invités, ent
 | 
			
		||||
Types d'activité
 | 
			
		||||
~~~~~~~~~~~~~~~~
 | 
			
		||||
 | 
			
		||||
Les activités sont triées par type (pots, soirées de club, ...), et chaque type regroupe diverses informations :
 | 
			
		||||
Les activités sont triées par type (pots, soirées de club,…), et chaque type regroupe diverses informations :
 | 
			
		||||
 | 
			
		||||
* Nom du type
 | 
			
		||||
* Possibilité d'inviter des non-adhérents (booléen)
 | 
			
		||||
 
 | 
			
		||||
@@ -65,9 +65,9 @@ Applications facultatives
 | 
			
		||||
* ``cas-server``
 | 
			
		||||
    Serveur central d'authenfication, permet d'utiliser son compte de la NoteKfet2020 pour se connecter à d'autre application ayant intégrer un client.
 | 
			
		||||
* `Script <https://gitlab.crans.org/bde/nk20-scripts>`_
 | 
			
		||||
     Ensemble de commande `./manage.py` pour la gestion de la note: import de données, verification d'intégrité, etc ...
 | 
			
		||||
     Ensemble de commande `./manage.py` pour la gestion de la note: import de données, verification d'intégrité, etc…
 | 
			
		||||
* `Treasury <treasury>`_ :
 | 
			
		||||
    Interface de gestion pour les trésoriers, émission de facture, remise de chèque, statistiques ...
 | 
			
		||||
    Interface de gestion pour les trésoriers, émission de facture, remise de chèque, statistiques…
 | 
			
		||||
* `WEI <wei>`_ :
 | 
			
		||||
    Interface de gestion du WEI.
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -43,7 +43,7 @@ l'utilisateur, utiles pour l'adhésion au BDE :
 | 
			
		||||
* ``address`` : ``CharField``, adresse physique de l'utilisateur
 | 
			
		||||
* ``paid`` : ``BooleanField``, indique si l'utilisateur normalien est rémunéré ou non (utile pour différencier les montants d'adhésion aux clubs)
 | 
			
		||||
* ``phone_number`` : ``CharField``, numéro de téléphone de l'utilisateur
 | 
			
		||||
* ``section`` : ``CharField``, section de l'ENS à laquelle apartient l'utilisateur (exemple : 1A0, ...)
 | 
			
		||||
* ``section`` : ``CharField``, section de l'ENS à laquelle appartient l'utilisateur (exemple : 1A0,…)
 | 
			
		||||
 | 
			
		||||
Clubs
 | 
			
		||||
~~~~~
 | 
			
		||||
@@ -59,7 +59,7 @@ utilisateurs aux différents clubs.
 | 
			
		||||
* ``membership_fee_paid`` : ``PositiveIntegerField``, montant de la cotisation (en centimes) pour qu'un élève normalien (donc rémunéré) puisse adhérer.
 | 
			
		||||
* ``membership_fee_unpaid`` : ``PositiveIntegerField``, montant de la cotisation (en centimes) pour qu'un étudiant normalien (donc non rémunéré) puisse adhérer.
 | 
			
		||||
* ``name`` : ``CharField``, nom du club.
 | 
			
		||||
* ``require_memberships`` : ``BooleanField``, indique si le club est un vrai club BDE qui nécessite des adhésions de club, ou s'il s'agit d'une note "pot commun" (organisation d'une activité, note de département, ...)
 | 
			
		||||
* ``require_memberships`` : ``BooleanField``, indique si le club est un vrai club BDE qui nécessite des adhésions de club, ou s'il s'agit d'une note "pot commun" (organisation d'une activité, note de département,…)
 | 
			
		||||
 | 
			
		||||
Adhésions
 | 
			
		||||
~~~~~~~~~
 | 
			
		||||
@@ -101,7 +101,7 @@ Adhésions
 | 
			
		||||
 | 
			
		||||
La Note Kfet offre la possibilité aux clubs de gérer l'adhésion de leurs membres. En plus de réguler les cotisations
 | 
			
		||||
des adhérents, des permissions sont octroyées sur la note en fonction des rôles au sein des clubs. Un rôle est une
 | 
			
		||||
fonction occupée au sein d'un club (Trésorier de club, président de club, GCKfet, Res[pot], respo info, ...).
 | 
			
		||||
fonction occupée au sein d'un club (Trésorier de club, président de club, GCKfet, Res[pot], respo info,…).
 | 
			
		||||
Une adhésion attribue à un adhérent ses rôles. Les rôles fournissent les permissions. Par exemple, le trésorier d'un
 | 
			
		||||
club a le droit de faire des transferts de et vers la note du club, tant que la source reste au-dessus de -50 €.
 | 
			
		||||
Une adhésion est considérée comme valide si la date du jour est comprise (au sens large) entre les dates de début et
 | 
			
		||||
 
 | 
			
		||||
@@ -49,7 +49,7 @@ Une fois l'inscription validée, détail de ce qu'il se passe :
 | 
			
		||||
  lui octroyant un faible nombre de permissions de base, telles que la visualisation de son compte.
 | 
			
		||||
* On adhère la personne au club Kfet si cela est demandé, l'adhésion commence aujourd'hui. Il dispose d'un unique rôle :
 | 
			
		||||
  "Adhérent Kfet", lui octroyant un nombre un peu plus conséquent de permissions basiques, telles que la possibilité de
 | 
			
		||||
  faire des transactions, d'accéder aux activités, au WEI, ...
 | 
			
		||||
  faire des transactions, d'accéder aux activités, au WEI,…
 | 
			
		||||
* Si le nouveau membre a indiqué avoir ouvert un compte à la société générale, alors les transactions sont invalidées,
 | 
			
		||||
  la note n'est pas débitée (commence alors à 0 €).
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -33,7 +33,7 @@ Produits
 | 
			
		||||
  * ``invoice`` : ``ForeignKey`` vers la facture associée au produit
 | 
			
		||||
  * ``designation`` : Désignation du produit
 | 
			
		||||
  * ``quantity`` : Quantité achetée
 | 
			
		||||
  * ``amount`` : Prix unitaire (HT) du produit (peut être négatif si jamais il s'agit d'un rabais, d'un solde prépayé, ...)
 | 
			
		||||
  * ``amount`` : Prix unitaire (HT) du produit (peut être négatif si jamais il s'agit d'un rabais, d'un solde prépayé,…)
 | 
			
		||||
 | 
			
		||||
Pour ajouter des produits à une facture, cela se passe sur le même formulaire d'ajout/de modification de factures.
 | 
			
		||||
Pour cela, on utilise un ``FormSet``, qui permet de gérer un nombre arbitraire de formulaires
 | 
			
		||||
@@ -208,7 +208,7 @@ Sur son interface, le trésorier peut récupérer les crédits de Société gén
 | 
			
		||||
 | 
			
		||||
* Demander à un respo info s'il y a un problème pour le régler avant de faire des bêtises. Je l'admets, ça fait trois options.
 | 
			
		||||
 | 
			
		||||
La validité d'une transaction d'adhésion n'a aucune influence sur l'adhésion elle-même. Toutefois, cela se remarque rapidement ...
 | 
			
		||||
La validité d'une transaction d'adhésion n'a aucune influence sur l'adhésion elle-même. Toutefois, cela se remarque rapidement…
 | 
			
		||||
 | 
			
		||||
.. image:: /_static/img/treasury_validate_sogecredit.png
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -285,7 +285,7 @@ On doit compiler les traductions (pour pouvoir les lire plus vite par la suite)
 | 
			
		||||
 | 
			
		||||
   $ ./manage.py compilemessages
 | 
			
		||||
 | 
			
		||||
Les fichiers statiques (fiches de style, fichiers Javascript, images, ...) doivent
 | 
			
		||||
Les fichiers statiques (fiches de style, fichiers Javascript, images,…) doivent
 | 
			
		||||
être exportées dans le dossier ``static`` :
 | 
			
		||||
 | 
			
		||||
.. code:: bash
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user