Skip to content

Latest commit

 

History

History
126 lines (87 loc) · 6.5 KB

INSTALL.md

File metadata and controls

126 lines (87 loc) · 6.5 KB

Installer l'application sur ta machine

Si tu as un problème ou une question, merci de me contacter par mail : [email protected]

Ce guide a été testé sur Linux (Ubuntu 20.04). Si tu utilises Windows, débrouille-toi ou installe Linux.

⚠️ Avant de commencer, merci de te familiariser avec les bases !

Table des matières

Tests locaux sous IOS

Cette étape n'est pas obligatoire pour développer dans un environnement Android.

La compilation et le test en simulateur de la version IOS nécessitent un environnement sous MacOS (qui doit être à jour avec la dernière version de XCode pour les versions releases). Historiquement on utilisait un service en ligne de machines MacOS avec accès à distance. Il s'avère que l'on peut utiliser une machine virtuelle directement sur sa propre machine sur Linux (je recommande 16 GO de RAM ou plus).

  • Machine virtuelle MacOS
  • Dédier à la VM 8 GO de RAM à la place de 4 en changeant le flag -m 4G en -m 8G dans le fichier basic.sh
  • XCode dans Additional downloads (ou depuis l'app store)
  • Homebrew : permet d'installer des logiciels facilement sous MacOS (et Linux)
  • Aller directement à l'étape 2

1. Installation de Git

Git permet de garder un historique de modification du code et de synchroniser les fichiers entre plusieurs machines. Tu trouveras un tutoriel pour te familiariser avec les bases ici.

Ouvre un terminal et entre la commande suivante pour l'installer :

sudo apt install git

2. Installation de React Native

Vas sur le site officiel puis sur l'onglet React Native CLI Quickstart, et sélectionne ensuite ta plateforme de développement et celle de ta cible.

Par exemple, si tu as un PC sous linux et un téléphone Android, sélectionne donc Linux et Android.

⚠️ Ne choisis pas Expo CLI Quickstart, suis bien les instructions pour React Native CLI Quickstart

Suis ensuite les instructions pour bien installer React Native sur ta machine. Va bien jusqu'à la fin. Tu devrais pouvoir créer une application vide qui se lance sur ton téléphone/émulateur.

3. Installation de l'application

Si tu as bien suivi les instructions plus haut, tu devrais pouvoir lancer une application vide sur un appareil. Si ce n'est pas le cas, recommence l'installation depuis le début. Si malgré tout tu n'y arrives pas, envoie-moi un petit mail : [email protected].

3.1 Téléchargement du dépôt

⚠️ La suite n'est valide que si tu veux compiler une version sans contribuer (pour avoir les toutes dernières modifications par exemple).

Si tu veux contribuer des modifications, rends-toi sur ce guide pour comprendre comment créer un fork.

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

git clone [email protected]:ClubInfoInsaT/application-amicale.git

Toute modification doit être réalisée sur une branche dédiée (pas de commit direct sur master). Cette nouvelle branche est ensuite fusionnée avec master une fois qu'elle est testée et vérifiée. Ainsi, en prenant la branche master a n'importe quel moment, il devrait être possible de compiler une version stable.

Plus d'informations sur l'organisation avec git ici.

3.2 Installation des dépendances

Une fois le dépôt sur ta machine et git sur la branche de ton choix, ouvre un terminal dans le dossier racine et installe les dépendances avec la commande suivante :

npm ci

Le paramètre ci indique à npm d'installer précisément comme dans le package-lock.json (que l'on ne modifie pas manuellement). Pour plus d'info se référer à cette réponse.

Si cette command donne une erreur indiquant que la version d'une dépendance n'est pas valide, utilise cette commande à la place:

npm ci --legacy-peer-deps

Si tu es sur macOS, tu devras aussi lancer la commande suivante pour installer les dépendances propres à iOS :

cd ios && NO_FLIPPER=1 pod install

En cas de problème d'installation (notamment lors du changement de branche), supprime le dossier node_modules et relance les commandes précédentes.

4. Lancement de l'application

Suis les instructions sur le site officiel pour lancer l'application. Il n'y a aucune différence avec une application classique.

Si tu utilises Webstorm, le projet contient des configurations de lancement pour lancer le projet d'un seul clic.

Il est possible de lancer un émulateur Android sans lancer Android Studio, ce qui permet de gagner en rapidité et en mémoire. Depuis un terminal (sur Linux):

# Récupérer la liste des emulateurs installés
emulator -list-avds
# En choisir un puis le lancer
emulator -avd <identifiant de l'émulateur> -no-boot-anim

Note: il faut avoir installé Android Studio et configuré un émulateur depuis l'interface. Dans certains cas npm run android lancera un émulateur.

5. Compiler une version release

Merci de me contacter par mail ou sur le Discord pour toute information sur les releases : [email protected]

Les releases de production se font en utilisant l'intégration continue (CI) avec Github Actions. Les workflows build-android et build-ios compilent et mettent en ligne une version signée de l'application sur la Console Google Play et Testflight respectivement. À partir de là, le build peut être mis en beta puis publié. Ne pas oublier d'utiliser npm version major/minor/patch pour changer la version (et les numéros de build). À noter que les demandes d'exécution des workflows de build doivent être validée par les mainteneurs.