Aller au contenu

Code source wiki de Accueil Hypercerts

Version 24.1 par dufour18 le 23/07/2020 - 09:30
Masquer les derniers auteurs
dufour18 22.1 1 Vous cherchez à délivrer aux étudiants de votre université des attestations de réussite dématérialisées ? Hypercerts vous permettera de générer et envoyer des attestations officielles, numériques, et infalsifiable de façon automatique.
Benjamin Seclier 1.1 2
dufour18 4.1 3 Ces dernières pourront être envoyées par mail, déposées dans le nuage, et même être certifiées authentiques et intègres grâce à une blockchain dédiée.
Benjamin Seclier 1.1 4
dufour18 4.1 5 Une fois l'application connectée à Apogée et au LDAP, les gestionnaires de composantes pourront demander la génération et l'envoi des attestations de réussite en un clic.
6
dufour18 3.1 7 {{info}}
dufour18 24.1 8 La version 1.0.x est une première version limitée à l'envoi des attestations par email. Bien que le cœur de l'application soit fonctionnel, les dépôts de documents dans les coffres digisposte et la certification cryptographique sont en cours de dévelopement actif.
dufour18 3.1 9 {{/info}}
Benjamin Seclier 1.1 10
Matthieu Manginot 7.1 11 == Prérequis ==
dufour18 3.1 12
dufour18 5.1 13 Hypercerts est une application Java qui se connecte à Apogée et au LDAP. Elle requiert l'utilisation d'une base MariaDB pour son fonctionnement interne. Elle se déploie sur des serveurs comme une application SpringBoot classique. Le WAR pourra être pris en charge par un tomcat et servir les utilisateur•ices via l'URL configuré.
dufour18 3.1 14
dufour18 2.1 15 |=(((
dufour18 3.1 16 Technologie
dufour18 2.1 17 )))|=(((
dufour18 3.1 18 Version
dufour18 2.1 19 )))
20 |(((
dufour18 3.1 21 JDK
dufour18 2.1 22 )))|(((
dufour18 3.1 23 11+
dufour18 2.1 24 )))
dufour18 3.1 25 |(% colspan="1" %)(((
26 SpringBoot
27 )))|(% colspan="1" %)(((
28 2.3
29 )))
30 |(% colspan="1" %)(((
31 Vaadin (Frontend)
32 )))|(% colspan="1" %)(((
33 14
34 )))
dufour18 2.1 35 |(((
dufour18 3.1 36 Tomcat
dufour18 2.1 37 )))|(((
dufour18 3.1 38 9+
39 )))
40 |(% colspan="1" %)(((
41 MariaDB
42 )))|(% colspan="1" %)(((
43 14+
44 )))
45 |(% colspan="1" %)(((
46 Maven
47 )))|(% colspan="1" %)(((
48 3.6+
49 )))
50 |(% colspan="1" %)(((
51 Connection Apogée
52 )))|(% colspan="1" %)(((
dufour18 2.1 53 \\
54 )))
dufour18 3.1 55 |(% colspan="1" %)(((
56 Connection Apogée via WS
57 )))|(% colspan="1" %)(((
dufour18 2.1 58 \\
dufour18 3.1 59 )))
60 |(% colspan="1" %)(((
61 Connection LDAP
62 )))|(% colspan="1" %)(((
dufour18 2.1 63 \\
64 )))
dufour18 3.1 65 |(% colspan="1" %)(((
66 Docker (optionnel)
67 )))|(% colspan="1" %)(((
68 docker-compose 3
69 )))
Benjamin Seclier 1.1 70
dufour18 4.1 71 == Téléchargement des sources ==
72
73 Provisoirement, les sources de l'application peuvent être téléchargées à [[cet endroit>>url:http://download-sig.univ-lorraine.fr/home/download-sig/public/hypercerts||shape="rect"]].
74
dufour18 2.1 75 == Personalisation d'Hypercerts ==
76
Matthieu Manginot 12.1 77 === Configuration l'application ===
dufour18 4.1 78
Matthieu Manginot 10.1 79 Créer et compléter un fichier **application.yaml** à la racine du projet sur le modèle de **application-sample.yaml**
80
Matthieu Manginot 19.1 81 === **Éléments de configuration important ** ===
82
Matthieu Manginot 23.1 83 ==== **Flyway** ====
84
85 **{{status colour="Yellow" title="TODO"/}}
86 **
87
Matthieu Manginot 19.1 88 ==== Property //app.production// ====
89
90 Pour les tests, mettre **app.production** à false pour obtenir une année supplémentaire (N-2) pour la génération, ainsi des diplômes avec résultats seront plus facilement trouvables.
91
92 En étant à false, cette property autorise également l'interception de tout les mails applicatifs.
93
94 ==== **Envoi de mail** ====
95
Matthieu Manginot 15.1 96 (% style="color: rgb(0,51,102);" %)__**Sur votre environnement de test/développement**, pour empêcher l'envoi de mails de test en réel, il est conseillé :__
Matthieu Manginot 11.1 97
98 * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp
99 * ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs :
100 ** **app.production** à false
101 ** **spring.mail.intercept.active** à true
102 ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
103
Matthieu Manginot 20.1 104 ==== WebServices Apogée ====
105
Matthieu Manginot 21.1 106 {{status colour="Yellow" title="TODO"/}}
Matthieu Manginot 20.1 107
Matthieu Manginot 12.1 108 === Configurer et lancer le projet dans Eclipse ===
109
110 * Importer le projet Maven dans eclipse.
Matthieu Manginot 19.1 111 * Lorsque la configuration est terminée, démarrer l'application en faisant un clic droit sur {{code language="none"}}fr.univlorraine.hypercerts.Application.java{{/code}} et en choisissant 'Run As / Java Application'.
Matthieu Manginot 12.1 112
Matthieu Manginot 14.1 113 === Customisation des services ===
114
Matthieu Manginot 18.1 115 Plusieurs services sont personnalisables en fonction de votre environnement.
Matthieu Manginot 14.1 116
Matthieu Manginot 17.1 117 Sous fr.univlorraine.hypercerts.apogee.service.customs :
Matthieu Manginot 16.1 118
Matthieu Manginot 17.1 119 * ApogeeUserServiceCustomExample
Matthieu Manginot 18.1 120 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
Matthieu Manginot 17.1 121 * BlocageServiceCustomExample
Matthieu Manginot 18.1 122 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
Matthieu Manginot 17.1 123 * ComposanteServiceCustomExample
Matthieu Manginot 18.1 124 ** Personnalisation de la récupération :
125 *** de toutes les composantes
126 *** des composantes pour un utilisateur à partir de l'uid LDAP
127 *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP
Matthieu Manginot 16.1 128
Matthieu Manginot 21.1 129 {{status colour="Yellow" title="TODO"/}}
130
Matthieu Manginot 17.1 131 === Customisation de Digiposte ===
132
133 //Documentation à venir.//
134
Matthieu Manginot 12.1 135 === Tâches Maven ===
136
137 * Lancer l'application (hors d'un IDE) :
138
139 {{code language="bash" theme="Eclipse"}}
140 mvn spring-boot:run
141 {{/code}}
142
143 * Lancer les tests :
144
145 {{code language="bash" theme="Eclipse"}}
146 mvn verify
147 {{/code}}
148
149 * Créer le package pour production :
150
151 {{code language="bash" theme="Eclipse"}}
152 mvn clean package -Pproduction
153 {{/code}}
154
Matthieu Manginot 13.1 155 === Makefile ===
156
157 Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.
158
Matthieu Manginot 14.1 159 == Tests unitaires ==
dufour18 4.1 160
Matthieu Manginot 13.1 161 Pour s'assurez que les résultats d'admission de vos étudiants soient bien correct, et afin d'éviter les faux positifs (donc envoyer une attestation de réussite à un•e étudiant•e non reçu•e aux examens), vous pouvez ajouter vos jeux de données
dufour18 4.1 162
Matthieu Manginot 14.1 163 {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}}
164
dufour18 5.1 165 == Mise en service de l'application ==
dufour18 2.1 166
dufour18 4.1 167 \\
168
Benjamin Seclier 1.1 169 {{section}}
170 {{column width="60%"}}
171 {{recently-updated/}}
172 {{/column}}
173
dufour18 2.1 174 {{column width="5%"}}
175 \\
176 {{/column}}
Benjamin Seclier 1.1 177
178 {{column width="35%"}}
179 ====== Navigate space ======
180
181 {{locationSearch reference="WebHome"/}}
182
183 {{pagetree/}}
184 {{/column}}
185 {{/section}}