Browse Source

Updated README.md

keplyx 1 year ago
parent
commit
992e2d8286
1 changed files with 36 additions and 24 deletions
  1. 36
    24
      README.md

+ 36
- 24
README.md View File

@@ -1,17 +1,20 @@
1
-# Application pour l'Amicale
1
+# CAMPUS - Application pour l'Amicale
2 2
 
3 3
 Créée pendant l'été 2019, cette application compatible Android et iOS permet aux étudiants d'avoir un accès facile aux informations du campus :
4 4
  - News de l'amicale
5 5
  - État des machines à laver
6
+ - Liste des événements sur le campus
6 7
  - Stock du Proximo
7 8
  - Emploi du temps
8 9
  - Menu du RU
9
-
10
-Ce dépot contient les source de cette application, modifiable par les étudiants de l'INSA Toulouse, sous licence GPLv3.
10
+ - Disponibilité des salles libre accès
11
+ - Réservation des Bib'Box
12
+ 
13
+Ce dépot contient la source de cette application, modifiable par les étudiants de l'INSA Toulouse, sous licence GPLv3.
11 14
 
12 15
 ## Contribuer
13 16
 
14
-Si vous voulez influencer le développement ? C'est très simple !
17
+Vous voulez influencer le développement ? C'est très simple !
15 18
 
16 19
 Pas besoin de connaissance, il est possible d'aider simplement en proposant des améliorations ou en rapportant des bugs par mail (vergnet@etud.insa-toulouse.fr) ou sur [cette page](https://git.etud.insa-toulouse.fr/vergnet/application-amicale/issues), en vous connectant avec vos login INSA.
17 20
 
@@ -20,30 +23,34 @@ Si vous avez assez de connaissances et vous souhaitez proposer des modification
20 23
 ## Technologies Utilisées
21 24
 Cette application est faite en JavaScript avec React Native (framework Open Source créé par Facebook), combinée avec Expo.
22 25
 
23
-Cette combinaison permet de n'avoir qu'un seul code JavaScript à écrire pour Android et iOS. Pour compiler pour la plateforme souhaitée, il suffit d'effectuer une commande, qui envoie le code sur les serveurs d'Expo pour compilation (voir section Installer). Plus besoin de Mac pour développer une application iOS !
26
+Cette combinaison permet de n'avoir qu'un seul code JavaScript à écrire pour Android et iOS. Pour compiler pour la plateforme souhaitée, il suffit d'effectuer une commande, qui envoie le code sur les serveurs d'Expo pour compilation (voir section Installer). Plus besoin de Mac pour développer une application iOS ! (Mais toujours besoin d'un pour publier sur l'App store...)
24 27
 
25 28
 
26 29
 ## Installer l'application depuis ce dépot
27 30
 
28
-**Avant de commencer, installez git et npm sur votre machine, puis clonez ce dépot.**
31
+**Avant de commencer, installez git, node et npm sur votre machine, puis clonez ce dépot.**
29 32
 
30 33
 ### Téléchargement du dépot et des dépendances
31 34
 
32 35
 Il est conseillé d'utiliser un logiciel comme **PHPStorm** (logiciel pro gratuit pour les étudiants) pour éditer l'application car ce logiciel est compatible avec les technologies utilisées.
33 36
 
34
-Une fois le dépot sur votre machine, ouvrez le projet dans PHPStorm, ouvrez le terminal et tapez `npm install`. Ceci installera toutes les dépendances listées dans le fichier _package.json_. Cette opération peut prendre quelques minutes et utilisera beaucoup d'espace disque (plus de 400Mo).
37
+Une fois le dépot sur votre machine, ouvrez le projet dans PHPStorm, ouvrez le terminal et tapez `npm install`. Ceci installera toutes les dépendances listées dans le fichier _package.json_. Cette opération peut prendre quelques minutes et utilisera beaucoup d'espace disque (plus de 300Mo).
38
+
39
+### Lancement de l'appli
35 40
 
36
-**--> /!\ Pour pouvoir changer de mode nuit/jour dynamiquement sans redémarrer l'application, j'ai été obligé de modifier une librairie. Il est possible que l'appplication plante si vous ne refaites pas les modifications vous même /!\ <--**
41
+#### En console
37 42
 
38
-Ceci est temporaire (on espère), car cette modification devrait être implémentée dans la librairie originale (un jour...).
43
+Ouvrez simplement une console dans le répertoire du projet et tapez :
39 44
 
40
-En attendant, allez dans le dossier de la librairie **native-base-shoutem-theme**, et ouvrez le fichier _index.js_ et _src/connectStyle.js_. Ensuite, faites les modification [comme indiqué ici](https://github.com/GeekyAnts/theme/pull/5/files/91f67c55ca6e65fe3af779586b506950c9f331be#diff-4cfc2dd4d5dae7954012899f2268a422).
45
+`expo start`
41 46
 
42
-Ces modifications ont été acceptées dans la librairié originale, mais pas encore présentes dans la version sur npm.
47
+Cette commande va démarrer le Metro Bundler permettant de lancer l'appli. Attendez quelques instants, quand un QR code apparait, l'application est prête à être lancée sur votre téléphone.
43 48
 
44
-### Paramétrage de PHPStorm
49
+**Ne stoppez pas le Metro Bundler dans la console a chaque changement !** Toutes les modifications sont appliquées automatiquement, pas besoin de stopper et de redémarrer pour des petits changements ! Il est seulement nécessaire de redémarrer le Metro Bundler quand vous changez des librairies ou des fichiers.
45 50
 
46
-Il faut maintenant paramétrer PHPStorm pour pouvoir lancer facilement l'application. Nous utilisons ici expo, il faut donc dire à PHPStorm de lancer une commande expo quand nous cliquons sur le bouton play.
51
+#### Directement avec PHPStorm
52
+
53
+Si vous n'aimez pas la console et voulez utiliser le merveilleux bouton play de PHPStorm, il faut le paramétrer. Nous utilisons ici expo, il faut donc dire à PHPStorm de lancer une commande expo quand nous cliquons sur le bouton play.
47 54
 
48 55
 Pour cela, cliquez sur **Edit Configurations** en haut à droite, dans la nouvelle fenêtre, cliquez sur **+**, et choisissez **React Native**.
49 56
 
@@ -54,29 +61,34 @@ Ensuite, dans **Before Launch**; cliquez sur **+** pour ajouter une nouvelle con
54 61
 [Plus d'informations ici](https://www.jetbrains.com/help/phpstorm/react-native.html)
55 62
 
56 63
 Le projet est maintenant pret, quand vous cliquez sur run (ou shift+F10), le projet sera lancé (cela peut prendre plusieurs minutes).
57
-Une fois lancé, vous pouvez tester sur un appareil.
64
+Quand un QR code apparait, vous pouvez tester sur un appareil.
58 65
 
59
-### Tester sur un appareil
66
+**Ne stoppez pas le Metro Bundler dans la console a chaque changement !** Toutes les modifications sont appliquées automatiquement, pas besoin de stopper et de redémarrer pour des petits changements ! Il est seulement nécessaire de redémarrer le Metro Bundler quand vous changez des librairies ou des fichiers.
60 67
 
61
-Assurez vous d'avoir installer et lancé le projet comme expliqué plus haut.
68
+### Tester sur un appareil
62 69
 
63
-#### Emulateur android
70
+Assurez vous d'avoir installé et lancé le projet comme expliqué plus haut.
64 71
 
65
-[Suivez la procédure sur ce lien](https://docs.expo.io/versions/latest/workflow/android-studio-emulator/).
72
+#### Émulateur android
66 73
 
67
-Une fois l'emulateur installé et démarré, lancez le projet, puis appuyez sur la touche **a** dans la console _Run_, cela lancera l'aplication dans l'émulateur.
74
+[Suivez la procédure sur ce lien pour installer un émulateur](https://docs.expo.io/versions/latest/workflow/android-studio-emulator/).
68 75
 
69
-**Ne stoppez pas l'application depuis PhpStorm ! Toutes les modifications sont appliquées automatiquement, pas besoin de stopper et de redémarrer !**
76
+Une fois l'emulateur installé et démarré, lancez le projet, puis appuyez sur la touche **a** dans la console, cela lancera l'aplication dans l'émulateur.
70 77
 
71 78
 #### Appareil Physique
72 79
 
73 80
 Installez l'application **Expo** sur votre appareil (android ou iOS), assurez vous d'avoir démarré le projet et d'avoir votre machine de développement et le téléphone sur le même réseau wifi (non publique). Ouvrez l'application expo, Votre projet devrait apparaitre dans la liste. Cliquez dessus et c'est bon !
74 81
 
75
-**Ne stoppez pas l'application depuis PhpStorm ! Toutes les modifications sont appliquées automatiquement, pas besoin de stopper et de redémarrer !**
76
-
82
+Si vous utilisez le réseau Wifirst des résidences INSA (ou tout autre wifi publique), il y a une méthode très simple pour créer un réseau privé entre votre PC et votre téléphone (en tout cas avec un téléphone android). Connectez votre téléphone en Wifi au réseau, puis connectez le en USB à votre PC. Une fois connecté, allez dans les paramètres et activez le "USB Tethering". Votre PC est maintenant connecté en réseau filaire à votre téléphone, qui lui est connecté à Internet par la wifi. Si vous voulez connecter d'autres appareils, il suffit de créer un Hotspot sur votre PC et de connecter vos autres appareils à ce Hotspot. Profitez de votre réseau privé dans votre Promolo !
77 83
 
78 84
 ## Compilation
79 85
 
80
-Pour compiler sur android, tapez la commande `expo build:android` dans une terminal dans le projet. Ensuite attendez.
86
+Avant de compiler, créez vous un compte Expo. Ensuite, lancez le Metro Bundler et connectez vous a votre compte dans la console (les touches sont indiquées).
87
+
88
+Pour compiler sur android, vous avez deux solutions:
89
+ - Vous voulez générer un `.apk` pour pour l'installer sur votre téléphone, lancez cette commande dans un terminal dans le projet : `expo build:android`. Cette commande va générer les paquets nécessaires à Expo et les envoyer sur leurs serveurs. Ne touchez à rien pendant la création des paquets (cela peut prendre une à deux minutes). Une fois que vous voyez écrit `Build in progress...`, vous pouvez fermer votre console : les serveurs ont pris la main et vous avez un lien pour analyser la progression. Ce processus dure en général 8 minutes. Si vous ne fermez pas la console, vous aurez un lien direct pour télécharger le fichier `.apk`, sinon connectez vous sur votre compte Expo, rubrique Builds pour le télécharger.
90
+ 
91
+ - Vous voulez compiler pour ensuite publier sur le Play Store, lancez cette commande dans un terminal dans le projet : `expo build:android -t app-bundle`. Cette commande fait exactement la même chose que la précédente à une chose près. Vous obtiendre un fichier `.aab`, qui est un format optimisé pour le Play Store. Ce fichier est plus volumineux mais permet au Play Store de générer les apk les plus optimisés possible pour différentes architectures de téléphone.
92
+ 
81 93
 
82
-Pou compiler sur iOS, vous aurez besoin du compte développeur de l'amicale.
94
+Pou compiler sur iOS, vous aurez besoin du compte développeur de l'amicale car un tel compte est payant.

Loading…
Cancel
Save