lpitault/application-amicale
1
0
Fork 0
forked from vergnet/application-amicale
Code Issues Pull requests Releases Wiki Activity
application-amicale/INSTALL.md

7.7 KiB
Raw Blame History

Installer l'application depuis ce dépot

Vous allez devoir installer git, node et npm sur votre machine, puis cloner ce dépôt.

Tout est expliqué dans ce guide, si vous avez un problème ou une question, merci de me contacter par mail : app@amicale-insat.fr

Ce guide à été testé sur Linux (Ubuntu 18.04). Si vous utilisez Windows, débrouillez-vous ou installez Linux j'ai la flemme de tester.

Table des matières

Installation de Git

Entrez la commande suivante pour l'installer :

sudo apt install git

Installation de node

Vous devez avoir une version de node > 12.0. Pour cela, vérifiez avec la commande :

nodejs -v

Si ce n'est pas le cas, entrez les commandes suivantes pour installer la version 12 (plus d'informations sur ce lien):

curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs

Installation de React Native

Merci de cliquer sur ce lien et de suivre la procédure d'installation officielle sous l'onglet React Native CLI Quickstart, en sélectionnant ensuite votre plateforme.

Téléchargement du dépôt

Clonez ce dépôt à l'aide de la commande suivante :

git clone https://git.etud.insa-toulouse.fr/vergnet/application-amicale.git

Toute modification doit être réalisée sur la branche de développement (pas de commit direct sur master). Dev est ensuite fusionnée avec master une fois qu'une version stable est prête. Ainsi, en prenant la branche master a n'importe quel moment, il devrait être possible de compiler une version stable.

Si vous voulez utiliser la branche de développement, réalisez la commande suivante :

git checkout dev

Pour revenir sur la branche principale, effectuez la commande

git checkout master

Téléchargement des dépendances

Une fois le dépôt sur votre machine et git sur la branche de votre choix, ouvrez le terminal dans le dossier du dépôt cloné 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).

En cas de problème d'installation (notamment lors du changement de branche), lancez la commande suivante pour tout réinstaller :

./clear-node-cache.sh

Instructions pour iOS

Pour iOS, en plus de la commande précédente, il faut aussi installer les dépendances iOS. Pour cela, allez dans le dossier ios et installez les pods grâce à la commande suivante :

cd ios && pod install

Lancement de l'appli

Il est conseillé d'utiliser un logiciel comme WebStorm (logiciel pro gratuit pour les étudiants) pour éditer l'application car ce logiciel est compatible avec les technologies utilisées.

Vous aurez besoin de 2 consoles :

  • Une pour lancer le Bundler, qui permet de mettre à jour l'application en temps réel (vous pouvez le laisser tout le temps ouvert).
  • Une autre pour installer l'application sur votre appareil/simulateur.

Pour lancer le Bundler, assurez vous d'être dans le dossier de l'application, et lancez cette commande :

npx react-native start

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.

Android

PRÉREQUIS : Il est nécessaire de générer un fichier keystore.debug dans le dossier android/app pour qu'android puisse détecter que l'application est une version de debug. Pour cela, lancez la commande suivante :

cd android/app && keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000

Ensuite, vous aurez besoin de créer un autre fichier dans le dossier android/, appelé gradle.properties avec le contenu suivant :

gradle.properties 
# Project-wide Gradle settings.

# IDE (e.g. Android Studio) users:
# Gradle settings configured through the IDE *will override*
# any settings specified in this file.

# For more details on how to configure your build environment visit
# http://www.gradle.org/docs/current/userguide/build_environment.html

# Specifies the JVM arguments used for the daemon process.
# The setting is particularly useful for tweaking memory settings.
# Default value: -Xmx10248m -XX:MaxPermSize=256m
# org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8

# When configured, Gradle will run in incubating parallel mode.
# This option should only be used with decoupled projects. More details, visit
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
# org.gradle.parallel=true

# AndroidX package structure to make it clearer which packages are bundled with the
# Android operating system, and which are packaged with your app's APK
# https://developer.android.com/topic/libraries/support-library/androidx-rn
android.useAndroidX=true
# Automatically convert third-party libraries to use AndroidX
android.enableJetifier=true
# Version of flipper SDK to use with React Native
FLIPPER_VERSION=0.33.1

Ce fichier n'est pas synchronisé sur git car il peut contenir des secrets relatifs à la clé de signature du build de release.

Dans la deuxième console, lancez la commande suivante :

npx react-native run-android

iOS

PRÉREQUIS : Il faut être connecté avec le compte développeur de l'amicale sur Xcode pour pouvoir compiler !

Dans la deuxième console, lancez la commande suivante (valable que sur Mac) :

npx react-native run-ios

Tester sur un appareil

Assurez vous d'avoir installé et lancé le projet comme expliqué plus haut.

Android

Émulateur

Suivez la procédure sur ce lien pour installer un émulateur.

Une fois l'emulateur installé et démarré, lancez l'application comme expliqué plus haut.

Appareil Physique

Branchez votre appareil, allez dans les options développeurs et activer le USB Debugging. Une fois qu'il est activé et branché, lancez l'appli comme expliqué plus haut.

iOS

Émulateur

Installez le logiciel Xcode et téléchargez l'émulateur de votre choix. Ensuite, lancez la commande suivante pour lancer l'application sur votre émulateur.

npx react-native run-ios --simulator="NOM DU SIMULATEUR"

En remplaçant NOM DU SIMULATEUR par le simulateur que vous voulez.

Appareil Physique

Aucune idée je suis pauvre je n'ai ni Mac ni iPhone.

Compiler une version release

Merci de me contacter par mail pour toute information sur les release : app@amicale-insat.fr