Application Mobile Campus

L'application étudiante de l'INSA Toulouse, faite par des étudiants !

Présentation de l'appli

banner

google-playapp-store

Projet démarré pendant l’été 2019 par Arnaud Vergnet (alors en 3MIC), cette application compatible Android et iOS permet aux étudiants d’avoir un accès facile aux informations du campus :

…et bien d’autres services

Le code source de l'application est disponible ici, et celle du serveur ici.

🗨️ Des questions ? Viens discuter sur Discord !

️☑️ Organisation sur Trello

🔎 Besoin de mainteneur

Ce projet a été réalisé en grande partie par un seul étudiant, mais cet étudiant (coucou c’est moi) ne va pas rester éternellement à l’INSA. Il faut donc une relève ! Le projet étant stable, le minimum est de corriger les bugs rencontrés.

Tout le monde peut contribuer, mais il faut tout de même au moins une personne pour gouverner le projet : accepter les modifications, compiler et mettre en ligne sur les magasins. Pas besoin d’énormément de connaissance, seulement de la motivation.

Le tout, bien sûr, permet de valoriser une implication citoyenne 😉.

👨‍💻 Technologies Utilisées

Cette application est faite en JavaScript avec React Native (framework Open Source créé par Facebook).

React Native 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 simple commande. Plus besoin de Mac pour développer une application iOS ! (Mais toujours besoin d’un pour compiler et publier sur l’App store…)

Tu trouveras une liste de liens pour retrouver toutes les infos !

📔️ Notes de changement

🗒️ Notes sur l’état actuel du projet

🤝 Contributeurs

app-store app-store

Arnaud Vergnet Yohan Simard Toi ?
Créateur et mainteneur actuel Correction de quelques bugs Contribue pour faire vivre le projet !

👏 Remerciements

📄 Licence

L’application est Open Source sous licence GPLv3.

🔐 Copyright

Google Play et le logo Google Play sont des marques de Google LLC.

Liens utiles

Voici une liste de liens qui pourraient t’être utile, que ce soit pour contribuer ou tout simplement pour comprendre comment l’application fonctionne sous le capot.

👶 Les bases

Le strict minimum pour pouvoir comprendre le code de l’application. Il n’est pas nécessaire d’avoir de grandes connaissances en JavaScript ou Git pour lire le code, mais une compréhension du fonctionnement et de la syntaxe de React Native est nécessaire pour pouvoir le modifier.

  • Des cours d’anglais : Toutes les ressources sont en anglais, le code est en anglais, tu trouveras presque rien en français, donc profite-en pour t’améliorer !
  • Tutoriel Git : Le système utilisé pour synchroniser le code entre plusieurs ordinateurs. Tout le projet repose sur cette technologie, une compréhension minimale de son fonctionnement est nécessaire. Si tu ne sais pas ce que veut dire commit, pull, push, merge, ou branch, alors lis ce tuto !
  • Tutoriel JavaScript : Un minimum de connaissances en JavaScript est nécessaire pour pouvoir comprendre le code. Pas besoin de lire tout le tutoriel. Pour les bases, tu peux t’arrêter à la partie JS Dates ou un peu avant. Il est utile de revenir souvent vers ce guide quand tu rencontres des difficultés.
  • Documentation React Native : La techno de base, qui utilise JavaScript. Lire au moins les articles de la catégorie The Basics, tout est interactif c’est plutôt simple et rapide à comprendre.

🤔 Comprendre les librairies

Si tu as compris les bases et que tu veux te plonger un peu plus en profondeur dans le code, tu peux utiliser les liens ci-dessous pour accéder aux frameworks les plus importants.

  • Documentation Flow : Un utilitaire pour rendre JavaScript typé statique (c’est-à-dire plus robuste pour de gros projets). Flow permet de rajouter des annotations pour donner un type aux variables.
  • Documentation React Native Paper : Le framework utilisé pour créer l’interface utilisateur (UI). Paper met à disposition de nombreux composants respectant les normes Material Design. Comparé à d’autres frameworks, paper est léger et facile à utiliser.
  • Documentation React Navigation : Le framework utilisé pour faciliter la navigation classique entre différents écrans. Permet de créer facilement une navigation par onglets/menu déroulant.
  • Liste des librairies : Tu trouveras dans ce fichier la liste de toutes les librairies utilisées dans ce projet (catégorie dependencies). Pour accéder à leur documentation, fais une simple recherche de leur nom dans un moteur de recherche.

🤯 Les Plus

Si t’es vraiment à fond dans le projet et que tu veux faire des trucs trop ouf, tu peux lire ça. Même moi j’ai eu la flemme de tout lire.

💻 Les Logiciels

Tu ne sais pas trop quel logiciel utiliser ? C’est normal y’a beaucoup de choix, mais tu trouveras ici une liste très réduite de logiciels qui marchent bien pour le développement.

  • Webstorm : Un logiciel pas mal que j’utilise et gratuit pour les étudiants/projets open-source. C’est un IDE (environnement de développement intégré) compatible React Native, ce qui veut dire qu’il possède de très nombreuses fonctionnalités pour simplifier le développement (debugging, refactoring, auto-complétion intelligente, et autre).
  • VSCodium : Un logiciel plus simple/léger que Webstorm mais avec un peu moins de fonctionnalités. Ce n’est pas un IDE mais un éditeur de text avec des plugins. Il est donc moins puissant que Webstorm, mais plus léger e plus simple à prendre en main.

Installer l'application sur ta machine

Si tu as un problème ou une question, merci de me contacter par mail : app@amicale-insat.fr

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

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

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

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.

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 : app@amicale-insat.fr.

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 https://git.etud.insa-toulouse.fr/vergnet/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.

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 install

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

cd ios && pod install

En cas de problème d’installation (notamment lors du changement de branche), lance la commande suivante pour réinstaller seulement les modules node utilisés :

./clear-node-cache.sh 

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.

Compiler une version release

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

Guide de contribution

Comment influencer le développement ? C'est très simple, pas besoin de grandes connaissances !

Guide de contribution

Comment contribuer ?

Tu veux influencer le développement ? C’est très simple ! Tu trouveras une liste de choses à faire sur Trello.

🙃 Aucune connaissance ?

Pas de problème ! Tu peux aider simplement en proposant des améliorations ou en rapportant des bugs par mail (app@amicale-insat.fr), sur Discord, ou sur cette page en te connectant avec tes login INSA.

🌍 Bilingue ou plus ?

Tu peux aider à traduire l’application ! Le projet existe en français et anglais (mais il peut y avoir des fautes !), et toute autre langue est la bienvenue.

Si tu es intéressé, rends-toi sur cette page pour plus de détails.

🤓 Développeur dans l’âme ?

Peu importe ton niveau, toutes les propositions de modification sont les bienvenues ! (enfin presque)

Pour cela, suis ce guide.

🤯 Motivé mais perdu ?

Tu es quand même le bienvenu ! Tu trouveras une liste de liens pour t’aider à comprendre les technologies utilisées dans ce projet. Si tu as plus de questions, tu peux toujours me contacter par mail (app@amicale-insat.fr).

Guide de contribution

Contribuer du code

Tu veux contribuer au projet ? Mais c’est magnifique ! Ce guide va te montrer comment faire pour contribuer tes modifications.

Si tu as des problèmes ou des questions, n’hésite pas à me contacter par mail (app@amicale-insat.fr).

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

Prérequis

Avant toute chose, tu dois installer React Native et git sur ta machine. Pour cela, suis ce guide jusqu’à l’étape 3.

Quoi faire ?

Tu trouveras une liste de choses à faire sur Trello.

Fork du projet

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 : app@amicale-insat.fr.

Il est maintenant temps de Fork le projet. Le dépôt officiel est protégé pour éviter le vandalisme. Un fork permet de copier le code du dépôt officiel et de le lier à ton compte. Sur cette nouvelle version, tu pourras faire les modifications que tu veux, et ensuite demander de fusionner ces modifications avec le dépôt officiel. Le mainteneur actuel du projet vérifiera alors tes modifications et décidera ou non de les accepter.

Plus d’infos sur git ici.

Créer un fork est très simple. Pour cela, suis ces instructions :

Création d’une nouvelle branche

Comme indiqué sur ce guide, chaque fonctionnalité doit être développée dans sa propre branche puis fusionnée avec le master du dépôt officiel.

Pour créer une nouvelle branche, utilise la commande suivante :

git checkout -b <branch-name>

En remplaçant <branch-name> par le nom souhaité (sans espaces !). Ce nom doit décrire rapidement ce que tu veux faire grâce à tes modifications.

Tu es maintenant sur ta nouvelle branche et prêt à faire tes modifications.

Réalisation d’une modification

Tu peux maintenant modifier ce que tu veux pour corriger un bug ou ajoute une fonctionnalité.

Mais avant de faire quoi que ce sois, merci de te signaler ! Cela évitera que plusieurs personnes corrigent le même bug ou de commencer à développer une fonctionnalité non voulue.

Pour installer l’appli sur ton téléphone/émulateur, reviens sur le guide d’installation, et reprends à la section 3.2.

Avant de passer à l’étape suivante, merci de bien vérifier et tester tes modifications.

Création d’une Pull Request

Cette étape te permet d’envoyer tes modifications sur le dépôt officiel, pour être intégrées à l’application disponible dans les magasins.

Tout se fait simplement sur le site en suivant ces instructions :

Et voilà tu as fait ta première pull request !

Si tu as des problèmes ou des questions, n’hésite pas à me contacter par mail (app@amicale-insat.fr).

Guide de contribution

Contribuer des traductions

Tu peux traduire l’application sans avoir de connaissance en programmation.

Pour cela, suis cette procédure :

Envoie-moi un mail avant de commencer pour me prévenir que tu veux travailler sur une traduction. Cela me permettra de te mettre en relation avec d’autres personnes travaillant également sur cette traduction.

Tu peux traduire dans la langue que tu veux, sachant que le français et l’anglais sont déjà fait.

Guide de contribution

Organisation du travail

⚠️ Ce projet dépend entièrement sur Git. Si tu n’es pas familier à cette technologie, rends-toi sur cette page avant de lire la suite.

La méthode ci-dessous est très fortement recommandée, car son efficacité a été testée et prouvée par de nombreux projets Open Source.

Ce qui suit a été inspiré des règles de KDE et largement simplifié.

Principes de base

La branche Master est toujours prête

Cette branche est le centre du projet. Elle ne doit contenir que des fonctionnalités et améliorations achevées. Elle doit être prête pour une release à tout moment. Le code doit donc être testé et validé.

Le développement à lieu dans les branches de ‘fonctionnalités’

Pour des corrections de bugs ou l’implémentation de nouvelles fonctionnalités qui demandent du travail, il est nécessaire de créer une nouvelle branche depuis master. Le développeur peut manipuler cette branche comme il le souhaite, mais elle doit être testée et vérifiée avant d’être fusionnée avec master.

Mainteneurs vs contributeur externe

Les contributeurs externes sont des volontaires qui veulent aider ponctuellement pour corriger des bugs/ajouter des fonctionnalités. Ils doivent suivre la procédure pour créer un fork du projet et faire une pull request pour intégrer leurs changements.

Les mainteneurs sont les personnes de confiance ayant un accès en écriture sur le dépôt officiel. C’est eux qui vérifient et acceptent les pull requests. Ils peuvent push et merge directement sur le dépôt officiel pour simplifier le développement.

Tu veux devenir contributeur ? Fais un tour par ici pour comprendre comment faire.
Tu es motivé et tu veux devenir mainteneur ? Contacte-moi par mail app@amicale-insat.fr.