Aller au contenu

Code source wiki de Accueil Hypercerts

Version 18.1 par Matthieu Manginot le 22/07/2020 - 16:21
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 (% 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é :__
82
83 * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp
84 * ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs :
85 ** **app.production** à false
86 ** **spring.mail.intercept.active** à true
87 ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
88
89 === Configurer et lancer le projet dans Eclipse ===
90
91 * Importer le projet Maven dans eclipse.
92 * 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'.
93
94 === Customisation des services ===
95
96 Plusieurs services sont personnalisables en fonction de votre environnement.
97
98 Sous fr.univlorraine.hypercerts.apogee.service.customs :
99
100 * ApogeeUserServiceCustomExample
101 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
102 * BlocageServiceCustomExample
103 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
104 * ComposanteServiceCustomExample
105 ** Personnalisation de la récupération :
106 *** de toutes les composantes
107 *** des composantes pour un utilisateur à partir de l'uid LDAP
108 *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP
109
110 === Customisation de Digiposte ===
111
112 //Documentation à venir.//
113
114 === Tâches Maven ===
115
116 * Lancer l'application (hors d'un IDE) :
117
118 {{code language="bash" theme="Eclipse"}}
119 mvn spring-boot:run
120 {{/code}}
121
122 * Lancer les tests :
123
124 {{code language="bash" theme="Eclipse"}}
125 mvn verify
126 {{/code}}
127
128 * Créer le package pour production :
129
130 {{code language="bash" theme="Eclipse"}}
131 mvn clean package -Pproduction
132 {{/code}}
133
134 === Makefile ===
135
136 Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.
137
138 == Tests unitaires ==
139
140 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
141
142 {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}}
143
144 == Mise en service de l'application ==
145
146 \\
147
148 {{section}}
149 {{column width="60%"}}
150 {{recently-updated/}}
151 {{/column}}
152
153 {{column width="5%"}}
154 \\
155 {{/column}}
156
157 {{column width="35%"}}
158 ====== Navigate space ======
159
160 {{locationSearch reference="WebHome"/}}
161
162 {{pagetree/}}
163 {{/column}}
164 {{/section}}