From 1dbdbc770f655dfad4f51aee6dd188da722e1c73 Mon Sep 17 00:00:00 2001 From: Pierre-antoine Comby Date: Sat, 21 Mar 2020 18:12:25 +0100 Subject: [PATCH] Update home --- home.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/home.md b/home.md index bde59d2..a36ef5d 100644 --- a/home.md +++ b/home.md @@ -1,3 +1,49 @@ Bienvenu sur le Wiki de la NoteKfet2020. Ce wiki est plutot orienté vers un public de développeur, qui souhaitent contribué au développement, mais expliquent également aux plus curieux comment fonctionne la NoteKfet2020 sous le capot. Des informations complémentaires sont également disponibles sur le [Wiki Crans](https://wiki.crans.org/NoteKfet/NoteKfet2020/) + +## Structure de la NoteKfet + +La NoteKfet est un projet Django, décomposé en applications. Certaines Applications sont développé uniquement pour ce projet, et sont indispensables, d'autre sont packagé et sont installées comme dépendances. Enfin Des fonctionnalités annexes ont été rajouté, mais ne sont pas essentiel au déploiement de la NoteKfet; leur usage est cependant recommandé. + +Le front utilise le framework Bootstrap4 et quelques morceaux de javascript custom. + +### Applications indispensables: + * `note_kfet`: + Application "projet" de django, c'est ici que la config de la note est gérée. + * `member`: + Gestion des profils d'utilisateurs, des clubs et de leur membres. + * `note`: + Les notes associés a des utilisateurs ou des clubs. + * `activity`: + La gestion des Activités (créations, gestion, entrée...) + * `rights`: + Backend de droits, limites les pouvoirs des utilisateurs + * `api`: + API REST de la note, est notamment utiliser pour rendre la note dynamique (notamment la page de conso) +### Applications packagées + * `polymorphic` + Utiliser pour la création de models polymorphiques (`Note` et `Transaction` notamment) cf [Note](Note). + + L'utilisation des models polymorphiques est détaillé sur la documentation du package: [https://django-polymorphic.readthedocs.io/en/stable/](https://django-polymorphic.readthedocs.io/en/stable/) + + * `crispy_forms` + Utiliser pour générer des forms avec bootstrap4 + * `django_tables2` + utiliser pour afficher des tables de données et les formater, en python plutot qu'en HTML. + * `restframework` + Base de l'api. + +### Applications facultatives + * `logs` + Enregistre toute les modifications effectuées en base de donnée. + * `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. + * `cas` + Client d'authenfication centralisé. permet de se connecter à la note via le CAS. + * `scripts` + Ensemble de commande `./manage.py` pour la gestion de la note: import de données, verification d'intégrité, etc... + + + +