guide du developpeur

Guide du développeur

Introduction

eXm est une application web de Gestion d'Examen qui est en fait un système réparti. Il a été conçu en HTML 5 avec le framework Bootstrap et la librairie Jquerry pour la partie graphique, en Go Lang avec le framework Iris pour la partie API et enfin avec Firebird comme système de Gestion de Base de données.

Environnement de développement et Pré-requis

Pour pouvoir développer adéquatement l'application eXm, chaque développeur aura besoin des éléments suivants:

1. Compte actif sur GitHub. Il faut demander à l'administrateur du projet d'ajouter votre compte GitHub comme étant l'un des "Collaborators", afin d'avoir accès en lecture et en écriture au dépot du projet.
2. Télécharger et installer Sublime Text 3, c'est l'éditeur qu'on utilise pour le Go Lang, vous pouvez le trouver sur son site officiel.
3. Il faut installer Go Lang sur la machine de développement, vous pouvez trouver les détails sur l'installation de Go Lang ICI
4. Télécharger et Copier (Dans Sublime Text le menu Preferences > Browse Packages) le package Go Sublime qui permettra de Compiler et de tester Go sur Sublime Text facilement, vous le trouverez sur Github
5. Il faut aussi installer le SGBDR Firebird, vous trouverez de façon détaillé les information sur l'instalation de Firebird ICI
6. Télécharger et installer le Client Graphique Flame Robin de Firebird pour une manipulation plus ergonomique du SGBD, vous pouvez le trouver ICI.
7. Bon nombre de dépendances Bootstrap et Jquerry peuvent être trouvées dans le modèle AdminBSB 1.0.5, il serait donc important de le garder sous la main.

Pour compiler/interpréter l'application

Pour compiler/interpréter vous devez Comprendre l'Architecture de l'application, pour ce faire exécuter les étapes ci-dessous

Tout d'abord vous devez télécharger le projet sur Github dans le dépot du projet.

La partie Graphique

Pour la partie Graphique de l'application, c'est-à-dire toutes les pages html et leurs dépendances, elles peuvent être interprétées en utilisant n'importe quel navgateur, à partir de n'importe quel répertoire.

La partie API

Après avoir installer Go Lang, si vous avez suivi toutes les étapes et fait le Hello Wolrd, vous avez un repertoire comme le suivant : "%USERPROFILE%\go\src".

Copier le folder eXmapi qui est dans le projet sur Github dans ce répertoire qui se trouve sur la machine de développement. Il est composé d'un ensemble de package tels model, dao et service écrit en Go lang, pour les compiler vous devez naviguer vers le répertoire eXmapi/main à partir d'une invite de commande tel que DOS puis saisir la commande : go build exmapi.go

La base de données

La structure de base de la base de données se trouve dans le répertoire > db qui est dans le projet sur Github. Le SGBD choisit facilite la portabilité, vous n'avez donc qu'à copier le fichier > EXM.FDB, qui est en fait la base de données et le mettre dans n'importe quel répertoire de la machine de développement, et c'est finit votre base est installée.

Pour Lancer/Tester l'application

Pour Lancer/Tester, exécuter les étapes ci-dessous

1. Modifier les informations de connexion à la base de données qui se trouve dans le fichier : eXmapi\ressource\serveur\db.json

2. Naviguer vers le répertoire eXmapi/main à partir d'une invite de commande tel que DOS puis saisir la commande : Pour windows par exemple : exmapi.exe -conf '%chemin menant ver le fichier db.json sur votre machine%' Pour Mac par exemple : exmapi.app -conf '%chemin menant ver le fichier db.json sur votre machine%'

3. Lancer la page index.html de la partie graphique de l'application

ça y est, vous avex eXm devant vous.