mirror of
https://github.com/ae-utbm/sith.git
synced 2024-11-26 02:54:20 +00:00
1 line
992 KiB
JSON
1 line
992 KiB
JSON
|
{"config":{"lang":["fr"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Documentation du site de l'association des \u00e9tudiants de l'UTBM","text":"<p>Bonjour, camarade.</p> <p>Si tu es ici, c'est sans doute pour mieux connaitre le fonctionnement interne du site AE. Peut-\u00eatre m\u00eame as-tu envie de contribuer \u00e0 son d\u00e9veloppement. Si tel est le cas, nous ne pouvons faire autrement que te souhaiter la bienvenue sur cette documentation et esp\u00e9rer que ce que nous avons \u00e9crit est assez clair et assez complet pour satisfaire ton esprit en qu\u00eate de connaissances.</p> <p>Et si tu viens pour d'autres motifs, \u00e7a ne change rien, soit le bienvenu (ou la bienvenue) quand m\u00eame.</p> <p>Pour que tu saches o\u00f9 chercher quelles informations, voici comment nous avons d\u00e9coup\u00e9 la documentation :</p> <ul> <li>Dans un premier temps, les explications, o\u00f9 nous discutons tout simplement de ce \u00e0 quoi nous pensions en faisant ceci ou cela, quels motifs ont guid\u00e9 tel ou tel choix... Bref, nous discutons du projet en tant qu'ensemble de choix, qu'en tant qu'accumulation de d\u00e9tails techniques. Des d\u00e9tails techniques, tu en trouveras quand m\u00eame, mais sans doute moins que dans les autres parties.</li> <li>Deuxi\u00e8mement, les tutoriels, o\u00f9 nous expliquons pas \u00e0 pas comment installer le projet et commencer \u00e0 travailler dessus. Vois-le comme une notice d'assemblage.</li> <li>Troisi\u00e8mement, les recettes, ou how-to, o\u00f9 nous pr\u00e9senterons des conseils, des proc\u00e9dures \u00e0 suivre et des patterns qui t'aideront peut-\u00eatre.</li> <li>Enfin, la r\u00e9f\u00e9rence, o\u00f9 sera donn\u00e9e en dur les d\u00e9tails techniques les plus intimes du projet, tir\u00e9s directement du code, qui ne seront sans doute pas d'une grande utilit\u00e9 pour comprendre le projet dans sa globalit\u00e9, mais qui seront bien plus utiles pour appr\u00e9hender l'impl\u00e9mentation de telle ou telle partie du code.</li> </ul>"},{"location":"explanation/","title":"Accueil","text":""},{"location":"explanation/#objectifs","title":"Objectifs","text":"<p>Le but de ce projet est de fournir \u00e0 l'Association des \u00c9tudiants de l'UTBM une plate-forme pratique et centralis\u00e9e de ses services. Le Sith de l'AE tient \u00e0 jour le registre des cotisations \u00e0 l'association, prend en charge la tr\u00e9sorerie, les ventes de produits et services, la diffusion d\u2019\u00e9v\u00e9nements, la gestion de la laverie et bien plus encore. </p> <p>C'est un projet b\u00e9n\u00e9vole qui tire ses origines des ann\u00e9es 2000. Il s'agit de la troisi\u00e8me version du site de l'AE. Son d\u00e9veloppement a commenc\u00e9 en 2015. C'est une r\u00e9\u00e9criture compl\u00e8te en rupture totale des deux versions qui l'ont pr\u00e9c\u00e9d\u00e9e.</p>"},{"location":"explanation/#pourquoi-reecrire-le-site","title":"Pourquoi r\u00e9\u00e9crire le site","text":"<p>L'ancienne version du site, sobrement baptis\u00e9e ae2, pr\u00e9sentait un nombre impressionnant de fonctionnalit\u00e9s. Il avait \u00e9t\u00e9 \u00e9crit en PHP et se basait sur son propre framework maison.</p> <p>Malheureusement, son entretien \u00e9tait plus ou moins hasardeux et son framework reposait sur des principes assez diff\u00e9rents de ce qui se fait aujourd'hui, rendant la maintenance difficile. De plus, la version de PHP qu'il utilisait \u00e9tait plus que d\u00e9pr\u00e9ci\u00e9e et \u00e0 l'heure de l'arriv\u00e9e de PHP 7 et de sa non-r\u00e9trocompatibilit\u00e9 il \u00e9tait vital de faire quelque chose. Il a donc \u00e9t\u00e9 d\u00e9cid\u00e9 de le r\u00e9\u00e9crire.</p>"},{"location":"explanation/#la-philosophie-initiale","title":"La philosophie initiale","text":"<p>Pour \u00e9viter les erreurs du pass\u00e9, ce projet met l'accent sur la maintenabilit\u00e9. Le choix des technologies ne s'est donc pas fait uniquement sur le fait qu'elle soit r\u00e9centes, mais \u00e9galement sur leur robustesse, leur fiabilit\u00e9 et leur potentie
|