Browse Source

Improved readme, changed version, changed about links

keplyx 2 years ago
parent
commit
3ef494f86a
4 changed files with 83 additions and 5 deletions
  1. 3
    0
      Changelog.md
  2. 76
    1
      README.md
  3. 1
    1
      app.json
  4. 3
    3
      screens/About/AboutScreen.js

+ 3
- 0
Changelog.md View File

@@ -0,0 +1,3 @@
1
+# Changelog
2
+
3
+Pas de version officielle.

+ 76
- 1
README.md View File

@@ -4,4 +4,79 @@ Créée pendant l'été 2019, cette application compatible Android et iOS permet
4 4
  - News de l'amicale
5 5
  - État des machines à laver
6 6
  - Stock du Proximo
7
- -
7
+ - Emploi du temps
8
+ - 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.
11
+
12
+## Contribuer
13
+
14
+Si vous voulez influencer le développement ? C'est très simple !
15
+
16
+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.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale/issues), en vous connectant avec vos login INSA.
17
+
18
+Si vous avez assez de connaissances et vous souhaitez proposer des modification dans le code, installez l'application sur votre machine, réalisez votre modification et créez une 'pull request'.
19
+
20
+## Technologies Utilisées
21
+Cette application est faite en JavaScript avec React Native (framework Open Source créé par Facebook), combinée avec Expo.
22
+
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 !
24
+
25
+
26
+## Installer l'application depuis ce dépot
27
+
28
+**Avant de commencer, installez git et npm sur votre machine, puis clonez ce dépot.**
29
+
30
+### Téléchargement du dépot et des dépendances
31
+
32
+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
+
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).
35
+
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 /!\ <--**
37
+
38
+Ceci est temporaire (on espère), car cette modification devrait être implémentée dans la librairie originale (un jour...).
39
+
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).
41
+
42
+Ces modifications ont été acceptées dans la librairié originale, mais pas encore présentes dans la version sur npm.
43
+
44
+### Paramétrage de PHPStorm
45
+
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.
47
+
48
+Pour cela, cliquez sur **Edit Configurations** en haut à droite, dans la nouvelle fenêtre, cliquez sur **+**, et choisissez **React Native**.
49
+
50
+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**.
51
+
52
+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.
53
+
54
+[Plus d'informations ici](https://www.jetbrains.com/help/phpstorm/react-native.html)
55
+
56
+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.
58
+
59
+### Tester sur un appareil
60
+
61
+Assurez vous d'avoir installer et lancé le projet comme expliqué plus haut.
62
+
63
+#### Emulateur android
64
+
65
+[Suivez la procédure sur ce lien](https://docs.expo.io/versions/latest/workflow/android-studio-emulator/).
66
+
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.
68
+
69
+**Ne stoppez pas l'application depuis PhpStorm ! Toutes les modifications sont appliquées automatiquement, pas besoin de stopper et de redémarrer !**
70
+
71
+#### Appareil Physique
72
+
73
+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
+
75
+**Ne stoppez pas l'application depuis PhpStorm ! Toutes les modifications sont appliquées automatiquement, pas besoin de stopper et de redémarrer !**
76
+
77
+
78
+## Compilation
79
+
80
+Pour compiler sur android, tapez la commande `expo build:android` dans une terminal dans le projet. Ensuite attendez.
81
+
82
+Pou compiler sur iOS, vous aurez besoin du compte développeur de l'amicale.

+ 1
- 1
app.json View File

@@ -10,7 +10,7 @@
10 10
       "android",
11 11
       "web"
12 12
     ],
13
-    "version": "0.0.7",
13
+    "version": "0.0.8",
14 14
     "orientation": "portrait",
15 15
     "primaryColor": "#be1522",
16 16
     "icon": "./assets/android.icon.png",

+ 3
- 3
screens/About/AboutScreen.js View File

@@ -13,10 +13,10 @@ const links = {
13 13
     appstore: 'https://qwant.com',
14 14
     playstore: 'https://qwant.com',
15 15
     expo: 'https://expo.io/@amicaleinsat/application-amicale',
16
-    git: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale',
16
+    git: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale/branch/master/README.md',
17 17
     bugs: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale/issues',
18
-    changelog: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale',
19
-    license: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale',
18
+    changelog: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale/src/branch/master/Changelog.md',
19
+    license: 'https://git.srv-falcon.etud.insa-toulouse.fr/vergnet/application-amicale/src/branch/master/LICENSE',
20 20
     mail: "mailto:arnaud.vergnet@netc.fr?subject=Application Amicale INSA Toulouse&body=",
21 21
     linkedin: 'https://www.linkedin.com/in/arnaud-vergnet-434ba5179/',
22 22
     facebook: 'https://www.facebook.com/arnaud.vergnet',

Loading…
Cancel
Save