From 0bcf6e3838492188d2dcaece302894450d738caa Mon Sep 17 00:00:00 2001 From: alain ibrahim Date: Wed, 8 Jan 2020 10:55:09 +0100 Subject: [PATCH] Update README.md --- README.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 9021a8d..dafe294 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,26 @@ Language Therapy est composé d'une application mobile et d'un site web ainsi qu Il sert de support pour la rééducation de patients aphasiques bilingues français-arabe sur un principe simple, le patient doit retrouver l'image correspondant à l'item affiché. - Neuf catégories sémantiques pour le moment - ![Alt text](readme/web-categories.jpg?raw=true "Categories") + + ![Categories|small](readme/web-categories.jpg?raw=true ) + - Création de test en choisissant une ou plusieurs catégories - ![Alt text](readme/web-testa.jpg?raw=true "Test exemple") + + ![Test exemple|small](readme/web-testa.jpg?raw=true ) + - Paramétrage du niveau de difficulté et d'autres options - ![Alt text](readme/web-parametres.jpg?raw=true "parametres") + + ![parametres|small](readme/web-parametres.jpg?raw=true) + - Mode image par image sans nom d'item affiché - ![Alt text](readme/web-imageparimage.jpg?raw=true "imageparimage") + + ![imageparimage|small](readme/readme/web-imageparimage.jpg?raw=true ) La version web est disponible ici http://88.190.14.12:1110/ ( authentification nécessaire ) ### Structure par sous projets -#### data-creator +* #### data-creator Script permettant à partir d'un dossier d'image de créer le fichier source utilisé par l'API et l'application Mobile. Mettre les images dans le dossier `mot-image` par catégories. Le nom des images doit respecter les régles suivantes : @@ -35,7 +42,7 @@ le script `app.js` : - copie dans l'application mobile les images ( `/mobile/ressources/mot-image/` ), les mp3 ( `/mobile/android/app/src/main/res/raw`) et le fichier data.js (`/mobile/ressources/data.js`) - copie dans l'API les images ( `/api/public/mot-image/` ), les mp3 ( `/api/public/mot-image/mp3/` ) et le fichier data.js ( `/api/data.js` ) -#### api +* #### api Api développée NodeJS @@ -54,9 +61,10 @@ Pour lancer les test sur `serieHelper` $ npm test // test si les series de test sont correctement formés ( bon nombre d'image en fonction de la difficulté ect) ``` +En hébergeant uniquement l'API en ligne (avec une version build du site web on obtient un site web fonctionnel, voir partie web build plus bas ) -#### web +* #### web Site web développé avec ReactJS @@ -65,22 +73,31 @@ $ cd web $ npm install $ npm start // ouvre chrome sur localhost:3000 ``` -Pour créer une version de production du site web (servable par n'importe quel serveur de fichier statique) + +L'adresse ip de l'API utilisée est définie dans `web/src/Config.js` + + +Pour créer une version de production du site web (servable par n'importe quel serveur de fichier statique, l'api ici ) ``` $ cd web $ npm run build - +dossier de sortie du build : /language_therapy/web/ +il faut copier le dossier language_therapy/web/build vers language_therapy/api/client/build/ ``` -#### mobile +* #### mobile L'application mobile a été developpée avec React-Native, testé uniquement sous Android +L'utilisation de reactNative est plus compliqué, je ne rentrerai pas dans les détails de l'installation mais elle requiert java,node,metro-bundler,android-studio et les drivers adb + ``` $ cd mobile $ npm install +$ ... lot of install +$ react-native run-android ``` ### Tech @@ -91,20 +108,3 @@ $ npm install - NodeJs - Docker -### Installation - -NodeJs is required -Clone this repo - -```sh -$ cd dillinger -$ npm install -d -$ node app -``` - -For production environments... - -``` -$ cd web -$ -```