Aller au contenu

Code source wiki de Accueil Hypercerts

Version 20.1 par Matthieu Manginot le 22/07/2020 - 16:31
Afficher les derniers auteurs
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.
2
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.
4
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
7 {{info}}
8 La version 1.0.x est une beta. 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.
9 {{/info}}
10
11 == Prérequis ==
12
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é.
14
15 |=(((
16 Technologie
17 )))|=(((
18 Version
19 )))
20 |(((
21 JDK
22 )))|(((
23 11+
24 )))
25 |(% colspan="1" %)(((
26 SpringBoot
27 )))|(% colspan="1" %)(((
28 2.3
29 )))
30 |(% colspan="1" %)(((
31 Vaadin (Frontend)
32 )))|(% colspan="1" %)(((
33 14
34 )))
35 |(((
36 Tomcat
37 )))|(((
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" %)(((
53 \\
54 )))
55 |(% colspan="1" %)(((
56 Connection Apogée via WS
57 )))|(% colspan="1" %)(((
58 \\
59 )))
60 |(% colspan="1" %)(((
61 Connection LDAP
62 )))|(% colspan="1" %)(((
63 \\
64 )))
65 |(% colspan="1" %)(((
66 Docker (optionnel)
67 )))|(% colspan="1" %)(((
68 docker-compose 3
69 )))
70
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
75 == Personalisation d'Hypercerts ==
76
77 === Configuration l'application ===
78
79 Créer et compléter un fichier **application.yaml** à la racine du projet sur le modèle de **application-sample.yaml**
80
81 === **Éléments de configuration important ** ===
82
83 ==== Property //app.production// ====
84
85 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.
86
87 En étant à false, cette property autorise également l'interception de tout les mails applicatifs.
88
89 ==== **Envoi de mail** ====
90
91 (% 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é :__
92
93 * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp
94 * ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs :
95 ** **app.production** à false
96 ** **spring.mail.intercept.active** à true
97 ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
98
99 ==== WebServices Apogée ====
100
101 TODO
102
103 === Configurer et lancer le projet dans Eclipse ===
104
105 * Importer le projet Maven dans eclipse.
106 * 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'.
107
108 === Customisation des services ===
109
110 Plusieurs services sont personnalisables en fonction de votre environnement.
111
112 Sous fr.univlorraine.hypercerts.apogee.service.customs :
113
114 * ApogeeUserServiceCustomExample
115 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
116 * BlocageServiceCustomExample
117 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
118 * ComposanteServiceCustomExample
119 ** Personnalisation de la récupération :
120 *** de toutes les composantes
121 *** des composantes pour un utilisateur à partir de l'uid LDAP
122 *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP
123
124 === Customisation de Digiposte ===
125
126 //Documentation à venir.//
127
128 === Tâches Maven ===
129
130 * Lancer l'application (hors d'un IDE) :
131
132 {{code language="bash" theme="Eclipse"}}
133 mvn spring-boot:run
134 {{/code}}
135
136 * Lancer les tests :
137
138 {{code language="bash" theme="Eclipse"}}
139 mvn verify
140 {{/code}}
141
142 * Créer le package pour production :
143
144 {{code language="bash" theme="Eclipse"}}
145 mvn clean package -Pproduction
146 {{/code}}
147
148 === Makefile ===
149
150 Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.
151
152 == Tests unitaires ==
153
154 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
155
156 {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}}
157
158 == Mise en service de l'application ==
159
160 \\
161
162 {{section}}
163 {{column width="60%"}}
164 {{recently-updated/}}
165 {{/column}}
166
167 {{column width="5%"}}
168 \\
169 {{/column}}
170
171 {{column width="35%"}}
172 ====== Navigate space ======
173
174 {{locationSearch reference="WebHome"/}}
175
176 {{pagetree/}}
177 {{/column}}
178 {{/section}}