|
@@ -24,8 +24,8 @@ Toute la partie métier de l'application a été écrite en javascript sans fram
|
|
|
|
|
|
#### Lancement
|
|
|
|
|
|
-Cette application ne peut être lancé uniquement avec Electron, il est **impossible** de lancer l'application autrement.
|
|
|
-En effet l'application utilise des fonctionnalité propre à Electron (et node.js) et ne peut donc être lancé que dans cet environnement.
|
|
|
+Cette application ne peut être lancée uniquement avec Electron, il est **impossible** de lancer l'application autrement.
|
|
|
+En effet l'application utilise des fonctionnalités propre à Electron (et node.js) et ne peut donc être lancée que dans cet environnement.
|
|
|
|
|
|
Pour lancer l'application il suffit d'utiliser l'une des commandes suivantes
|
|
|
|
|
@@ -42,8 +42,8 @@ De même lors de la fermeture de l'application si des fichiers temporaires on é
|
|
|
|
|
|
#### Compilation
|
|
|
|
|
|
-Il est théoriquement possible de compiler ce projet pour avoir un éxecutable de l'application. Cependant la compilation n'a jamais été testé.
|
|
|
-De plus la structure du projet prévu pour montrer l'interet et les possibilités d'Electron n'est pas fait pour être compilé et déployé sous forme d'executable.
|
|
|
+Il est théoriquement possible de compiler ce projet pour avoir un exécutable de l'application. Cependant la compilation n'a jamais été testée.
|
|
|
+De plus la structure du projet prévu pour montrer l'intéret et les possibilités d'Electron n'est pas fait pour être compilé et déployé sous forme d'exécutable.
|
|
|
La compilation est gérée par `Electron forge` et peut être lancé avec la commande suivante :
|
|
|
|
|
|
```bash
|
|
@@ -62,13 +62,13 @@ Les source de cette application sont disponible dans le dossier `app/` à la rac
|
|
|
- Le dossier `main/` qui contient le code source du processus principal d'Electron (plus d'informations dans la note Electron).
|
|
|
Les fichiers dans le dossier sont les fichiers de code éxecuté par Electron, le dosser `function/` regroupe les fonctions utilitaire pour ces fichiers et
|
|
|
le dossier `asset/` contient les icones utilisés par l'application.
|
|
|
-- Le dossier `renderer/` qui contient les fichiers pour le rendus de l'application. C'est dans ce dossier que ce trouve la base de code commune entre les deux version de l'application.
|
|
|
-Les fichier HTML à la racine du dossier sont les pages qui sont chargées par Electron au lancement.
|
|
|
+- Le dossier `renderer/` qui contient les fichiers pour le rendus de l'application. C'est dans ce dossier que ce trouve la base de code commune entre les deux versions de l'application.
|
|
|
+Les fichiers HTML à la racine du dossier sont les pages qui sont chargées par Electron au lancement.
|
|
|
Le dossier `common/` regroupe tous les fichiers Javascript et CSS commun à toutes les pages de l'application.
|
|
|
Le dossier `page/` contient toutes les pages de l'application, chaque page possède son propre dossier avec ces fichiers HTML et Javascript.
|
|
|
-Enfin dans le dossier `service/` ce trouve des class utilitaire pour gérer par exemple le stockage ou le routage entre les pages.
|
|
|
+Enfin dans le dossier `service/` ce trouve des class utilitaires pour gérer par exemple le stockage ou le routage entre les pages.
|
|
|
|
|
|
De plus le dossier `helper/` regroupe des fichiers de fonctions utilitaire à thème (par exemple la gestion des fichiers).
|
|
|
Ces fonctions sont utilisé dans toutes l'application (y comprit dans le fichier `main.js` qui est le fichier principal de l'application).
|
|
|
-Pour finir le dossier `data/` sert à stoquer les infos du dernier lancement (quel version de l'application a été utilisée, pour reset les données en cas de changement),
|
|
|
+Pour finir le dossier `data/` sert à stoquer les infos du dernier lancement (quel version de l'application a été utilisée, pour reset les données en cas de changement,
|
|
|
ainsi que les fichiers temporaires
|