Browse Source

Added install instructions and moved in separated file

Arnaud Vergnet 1 year ago
parent
commit
fe5b29a5cd
2 changed files with 152 additions and 66 deletions
  1. 151
    0
      INSTALL.md
  2. 1
    66
      README.md

+ 151
- 0
INSTALL.md View File

@@ -0,0 +1,151 @@
1
+# Installer l'application depuis ce dépot
2
+
3
+**Vous allez devoir installer git, node et npm sur votre machine, puis cloner ce dépot.**
4
+
5
+## Table des matières
6
+* [Installation de Git](#git)
7
+* Installation de node
8
+* Installation de expo-cli
9
+    * Configuration de NPM
10
+    * Installation
11
+* Téléchargement du dépot
12
+* Téléchargement des dépendances
13
+* Lancement de l'appli
14
+    * En console
15
+    * Directement avec PHPStorm
16
+* Tester sur un appareil
17
+    * Émulateur android
18
+    * Appareil Physique
19
+* Compilation
20
+
21
+<a name="git"></a>
22
+## Installation de Git
23
+
24
+Entrez la commande suivante pour l'installer :
25
+```shell script
26
+sudo apt install git
27
+```
28
+
29
+## Installation de node
30
+
31
+Vous devez avoir une version de node > 12.0.
32
+Pour cela, vérifiez avec la commande :
33
+```shell script
34
+nodejs -v
35
+```
36
+
37
+Si ce n'est pas le cas, entrez les commandes suivantes pour installer la version 12 ([plus d'informations sur ce lien](https://github.com/nodesource/distributions/blob/master/README.md#debinstall)):
38
+
39
+```shell script
40
+curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
41
+sudo apt-get install -y nodejs
42
+```
43
+
44
+## Installation de expo-cli
45
+
46
+### Configuration de NPM
47
+Il est nécessaire d'installer le paquet npm expo-cli de manière globale au système. Il est faut donc avoir les droits root pour l'installer. Une manière de contourner cette limitation est de changer le répertoire utilisé par npm pour les paquet globaux. Pour cela, procédez comme suit :
48
+
49
+Créez un dossier pour les paquets globaux  :
50
+```shell script
51
+mkdir ~/.npm-global
52
+```
53
+Configurez npm pour qu'il utilise ce nouveau dossier :
54
+```shell script
55
+npm config set prefix '~/.npm-global'
56
+```
57
+Ouvrez le fichier .profile dans votre dossier home (ou créez le si il n'existe pas) et ajoutez ces lignes à la fin pour ajouter les paquets globaux à votre PATH.
58
+```shell script
59
+NPM_STORE="${HOME}/.npm-global"
60
+PATH="$PATH:$NPM_STORE/bin"
61
+```
62
+Il est possible d'ajouter ces lignes dans le .bashrc a la place du .profile si vous n'utilisez expo qu'en console. Mais pour pouvoir l'utiliser depuis PhpStorm, il est necessaire de mettre à jour le PATH globalement avec le .profile et pas seulement pour les terminaux avec le .bashrc.
63
+
64
+Redémarrez votre système (ou simplement logout/login) pour appliquer ces changements.
65
+
66
+### Installation
67
+
68
+Vous pouvez maintenant installer expo-cli sans problèmes avec la commande suivante :
69
+
70
+```shell script
71
+npm install -g expo-cli
72
+```
73
+
74
+## Téléchargement du dépot
75
+
76
+Clonez ce dépot à l'aide de la commande suivante :
77
+````shell script
78
+git clone https://git.etud.insa-toulouse.fr/vergnet/application-amicale.git
79
+````
80
+
81
+## Téléchargement des dépendances
82
+
83
+Une fois le dépot sur votre machine, ouvrez le projet dans PHPStorm, ouvrez le terminal et tapez : 
84
+````shell script
85
+npm install
86
+````
87
+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).
88
+
89
+## Lancement de l'appli
90
+
91
+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.
92
+
93
+### En console
94
+
95
+Ouvrez simplement une console dans le répertoire du projet et tapez :
96
+
97
+````
98
+expo start
99
+````
100
+
101
+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.
102
+
103
+**Ne stoppez pas le Metro Bundler dans la console à 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.
104
+
105
+### Directement avec PHPStorm
106
+
107
+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.
108
+
109
+Pour cela, cliquez sur **Edit Configurations** en haut à droite, dans la nouvelle fenêtre, cliquez sur **+**, et choisissez **React Native**.
110
+
111
+Donnez un petit nom à cette configuration, décochez **Build and launch application** (nous utilisons expo pour ça, pas react native), mettez `127.0.0.1` dans le champ **Bundler Host**, et `19001` dans **Bundler Port**.
112
+
113
+Ensuite, dans **Before Launch**; cliquez sur **+** pour ajouter une nouvelle configuration, et choisissez **Start React Native Bundler** si il n'est pas déjà présent. Une fois ajouté, cliquez dessus, puis sur le bouton éditer (une icone de crayon). Dans la nouvelle fenetre, choisissez **npm script** dans le champ **Command** et **start** dans **Script**. Vérifiez que vous utilisez bien l'interpreteur Node associé au projet (pour utiliser les bonnes dépendances installées précédement), et cliquez sur OK.
114
+
115
+[Plus d'informations ici](https://www.jetbrains.com/help/phpstorm/react-native.html)
116
+
117
+Le projet est maintenant pret, quand vous cliquez sur run (ou shift+F10), le projet sera lancé (cela peut prendre plusieurs minutes).
118
+Quand un QR code apparait, vous pouvez tester sur un appareil.
119
+
120
+**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.
121
+
122
+## Tester sur un appareil
123
+
124
+Assurez vous d'avoir installé et lancé le projet comme expliqué plus haut.
125
+
126
+### Émulateur android
127
+
128
+[Suivez la procédure sur ce lien pour installer un émulateur](https://docs.expo.io/versions/latest/workflow/android-studio-emulator/).
129
+expo start
130
+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.
131
+
132
+### Appareil Physique
133
+
134
+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 !
135
+
136
+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 !
137
+
138
+## Compilation
139
+
140
+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).
141
+
142
+Pour compiler sur android, vous avez deux solutions:
143
+ - 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.
144
+ 
145
+ - 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.
146
+ 
147
+
148
+Pou compiler sur iOS, vous aurez besoin du compte développeur de l'amicale car un tel compte est payant.
149
+
150
+
151
+[reference]: ##Installation de Git

+ 1
- 66
README.md View File

@@ -25,70 +25,5 @@ Cette application est faite en JavaScript avec React Native (framework Open Sour
25 25
 
26 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...)
27 27
 
28
+## [Installer l'application depuis ce dépot](INSTALL.md)
28 29
 
29
-## Installer l'application depuis ce dépot
30
-
31
-**Avant de commencer, installez git, node et npm sur votre machine, puis clonez ce dépot.**
32
-
33
-### Téléchargement du dépot et des dépendances
34
-
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.
36
-
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
40
-
41
-#### En console
42
-
43
-Ouvrez simplement une console dans le répertoire du projet et tapez :
44
-
45
-`expo start`
46
-
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.
48
-
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.
50
-
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.
54
-
55
-Pour cela, cliquez sur **Edit Configurations** en haut à droite, dans la nouvelle fenêtre, cliquez sur **+**, et choisissez **React Native**.
56
-
57
-Donnez un petit nom à cette configuration, décochez **Build and launch application** (nous utilisons expo pour ça, pas react native), mettez `127.0.0.1` dans le champ **Bundler Host**, et `19001` dans **Bundler Port**.
58
-
59
-Ensuite, dans **Before Launch**; cliquez sur **+** pour ajouter une nouvelle configuration, et choisissez **Start React Native Bundler** si il n'est pas déjà présent. Une fois ajouté, cliquez dessus, puis sur le bouton éditer (une icone de crayon). Dans la nouvelle fenetre, choisissez **npm script** dans le champ **Command** et **start** dans **Script**. Vérifiez que vous utilisez bien l'interpreteur Node associé au projet (pour utiliser les bonnes dépendances installées précédement), et cliquez sur OK.
60
-
61
-[Plus d'informations ici](https://www.jetbrains.com/help/phpstorm/react-native.html)
62
-
63
-Le projet est maintenant pret, quand vous cliquez sur run (ou shift+F10), le projet sera lancé (cela peut prendre plusieurs minutes).
64
-Quand un QR code apparait, vous pouvez tester sur un appareil.
65
-
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.
67
-
68
-### Tester sur un appareil
69
-
70
-Assurez vous d'avoir installé et lancé le projet comme expliqué plus haut.
71
-
72
-#### Émulateur android
73
-
74
-[Suivez la procédure sur ce lien pour installer un émulateur](https://docs.expo.io/versions/latest/workflow/android-studio-emulator/).
75
-
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.
77
-
78
-#### Appareil Physique
79
-
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 !
81
-
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 !
83
-
84
-## Compilation
85
-
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
- 
93
-
94
-Pou compiler sur iOS, vous aurez besoin du compte développeur de l'amicale car un tel compte est payant.

Loading…
Cancel
Save