Application Mobile Campus

• Présentation de l'appli
• Liens utiles
• Installer l'application sur ta machine
• Guide de contribution
• Comment contribuer ?
• Contribuer du code
• Contribuer des traductions
• Organisation du travail
• Présentation de l'appli
• Tips d'utilisation de l'application
• À l'attention des clubs

Présentation de l'appli

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 :

• Connexion à son compte Amicale
• Liste des événements sur le campus
• État des machines à laver
• Emploi du temps

…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 !

️☑️ Feuille de route sur Github

 

⏩ Rejoindre la Beta

Avant de publier une nouvelle version de l'application au grand public, on effectue d'abord des tests avec un effectif réduit d'utilisateurs. On appelle cette phase le Beta Testing.

Pour rejoindre la Beta, il faut :

• Sur Android : rejoindre la Beta sur Google Play Store. Alternativement, des fichiers apk sont ponctuellement distribués sur le Discord.
• Sur IOS : Installer l'application Testflight et envoyer un message à Paul A sur Discord avec ton Apple ID.

Rejoindre le serveur discord du club pour être notifié lorsqu'une nouvelle version à tester arrive et savoir quelles fonctionnalités tester.

?‍? 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

			❔
Paul Alnet	Arnaud Vergnet	Yohan Simard	Toi ?
Mainteneur actuel	Créateur	Correction de quelques bugs	Contribue pour faire vivre le projet !

? Remerciements

• Béranger Quintana Y Arciosana : Étudiant en AE (2020) et Président de l’Amicale au moment de la création et du lancement du projet. L’application, c’était son idée. Il a beaucoup aidé pour trouver des bugs, de nouvelles fonctionnalités et faire de la com.
• Céline Tassin : Étudiante en GPE (2020). Sans elle, tout serait moins mignon. Elle a aidé pour écrire le texte, faire de la com, et aussi à créer la mascotte ?.
• Damien Molina : Étudiant en IR (2020) et créateur de la dernière version du site de l’Amicale. Grâce à son aide, intégrer les services de l’Amicale à l’application a été très simple.
• Titouan Labourdette : Étudiant en IR (2020). Il a beaucoup aidé pour trouver des bugs et proposer des nouvelles fonctionnalités.
• Théo Tami : Étudiant en AE (2020). Si l’application marche sur iOS, c’est grâce à son aide lors de ses nombreux tests.

? Licence

L’application est Open Source sous licence GPLv3.

? Copyright

Apple and Apple Logo are trademarks of Apple Inc.

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.

? 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.

? 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.

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 ou de venir en parler sur le Discord du Club Info

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://github.com/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.

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 contribuer ?

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

L'Équipe de développement étudiante de l'Amicale a vocation à maintenir le site de l'Amicale et l'Application Campus. À ce jour elle est dirigée par deux coresponsables Baptiste Rébillard (axé site) et Paul Alnet (axé appli & devops)

Le site est développé en php en utilisant le framework Laravel tandis que l'appli repose sur React-Native (Typescript/Javascript). L'application est open-source et tes contributions sont les bienvenues, que ce soit en terme de programmation, traduction, graphisme, test, suggestions ou retours ! L'équipe du site va s'élargir prochainement, rejoins-nous !

Tu peux trouver le code source de l'application sur le Github.

Si tu as une question, aimerais contribuer ou veux proposer une idée, n'hésite pas à mettre un message sur le Discord.

Si tu veux devenir beta-testeur :
- Android : Rejoins la beta sur Google Play et rejoins le Discord pour être averti.e des dernières features à tester !
- IOS : Envoie à Paul un message sur le Discord avec ton Apple ID, installe l'appli Testflight sur ton appareil et rejoins le Discord pour être averti.e des dernières features à tester !

? 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).

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 la feuille de route.

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 :

• Connecte-toi sur ce site (en haut à droite) avec tes identifiants INSA.
• Vas sur le dépôt officiel et clique sur ‘Fork’ en haut à droite.
• Le site te demandera des informations sur ce fork, tu n’as rien besoin de changer et tu peux juste cliquer sur ‘Fork Repository’.
• Tu arrives ainsi sur la page du dépôt ! Il est exactement comme le dépôt officiel, à quelques détails près. Si tu regardes en haut à gauche, à la place de vergnet/application-amicale, il y a maintenant ton nom ! Tu as donc fait une copie du dépôt officiel que tu as mis sur ton compte.
• Tu peux maintenant télécharger ce dépôt sur ta machine en utilisant la commande: shell script git clone [LINK] en remplaçant [LINK] par le lien que tu peux copier en haut à droite, au-dessus de la liste des fichiers.
• Tu as réussi à faire un Fork, bravo !

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 :

• Connecte-toi sur ce site (en haut à droite) avec tes identifiants INSA.
• Vas sur le dépôt officiel et clique sur l’onglet ‘Pull Requests’.
• Cette page t’affiche la liste de toutes les pull requests. Pour en créer une nouvelle, clique sur le bouton ‘New Pull Request’ en haut à droite.
• Tu arrives maintenant sur la page de création. Choisis master comme branche de destination, et ta branche créée précédemment comme source.
• Tu devrais voir en bas la liste de toutes tes modifications. Écris alors un titre présentant tes modifications (très court), et une description expliquant pourquoi elles sont nécessaires. Cela permettra d’expliquer au mainteneur pourquoi il devrait accepter tes modifications.
• Quand tout est bon, clique sur ‘Create Pull Request’ pour l’envoyer en attente de validation.
• Tu entreras ensuite en dialogue avec le mainteneur ! Il t’expliquera si certaines choses sont à modifier avant de fusionner dans master.

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).

Contribuer des traductions

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

Pour cela, suis cette procédure :

• Télécharge ce fichier. Tu y trouveras un ensemble de couples de la forme “clé”: “valeur”. Les clés servent à identifier les valeurs, il ne faut pas les modifier !
• Traduis les valeurs dans ce fichier dans la langue souhaitée.
• Envoie-moi par mail (app@amicale-insat.fr) ce fichier quand tu as terminé, il sera ajouté à la prochaine version de l’application.

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.

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.

Présentation de l'appli

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 :

• Connexion à son compte Amicale
• Liste des événements sur le campus
• État des machines à laver
• Emploi du temps

…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 !

️☑️ Feuille de route sur Github

 

⏩ Rejoindre la Beta

Avant de publier une nouvelle version de l'application au grand public, on effectue d'abord des tests avec un effectif réduit d'utilisateurs. On appelle cette phase le Beta Testing.

Pour rejoindre la Beta il faut :

• Sur Android : rejoindre la Beta sur Google Play Store. Alternativement, des fichiers apk sont ponctuellement distribués sur le Discord.
• Sur IOS : Installer l'application Testflight et envoyer un message à Paul A sur Discord avec ton Apple ID.
• Rejoindre le Discord pour être averti.e des changements et fonctionnalités à tester.

?‍? 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

			❔
Paul Alnet	Arnaud Vergnet	Yohan Simard	Toi ?
Mainteneur actuel	Créateur	Correction de quelques bugs	Contribue pour faire vivre le projet !

? Remerciements

• Béranger Quintana Y Arciosana : Étudiant en AE (2020) et Président de l’Amicale au moment de la création et du lancement du projet. L’application, c’était son idée. Il a beaucoup aidé pour trouver des bugs, de nouvelles fonctionnalités et faire de la com.
• Céline Tassin : Étudiante en GPE (2020). Sans elle, tout serait moins mignon. Elle a aidé pour écrire le texte, faire de la com, et aussi à créer la mascotte ?.
• Damien Molina : Étudiant en IR (2020) et créateur de la dernière version du site de l’Amicale. Grâce à son aide, intégrer les services de l’Amicale à l’application a été très simple.
• Titouan Labourdette : Étudiant en IR (2020). Il a beaucoup aidé pour trouver des bugs et proposer des nouvelles fonctionnalités.
• Théo Tami : Étudiant en AE (2020). Si l’application marche sur iOS, c’est grâce à son aide lors de ses nombreux tests.

? Licence

L’application est Open Source sous licence GPLv3.

? Copyright

Apple and Apple Logo are trademarks of Apple Inc.

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

Tips d'utilisation de l'application

Services de l'appli

Suivre les machines à laver

Possibilité de suivre en direct les machines à laver de la laverie de l'INSA et du tripode B et de se mettre un rappel n minutes avant la fin d'une machine.

Choisir la page d'accueil

Possibilité de choisir quelle page s'affiche de base lorsque vous lancez l'application

Mettre des classes en favori

Pratique pour les personnes anticipant des cours ou ayant des amis dans d'autres classes

 

Informations présentes sur l'appli

 

Voir la liste des clubs de l'amicale

Vous pouvez ensuite séléctionner une catégorie (ici technique par ex)

Voir la liste des événements à venir sur l'INSA

Un clic sur un événement affiche plus d'information sur celui-ci

Voir les salles en libre accès et réserver des salles à la Bib'

Liste des salles en libre-accès

(screenshot d'un samedi donc un peu rouge)

Liste des salles de la Bib'

il suffit de cliquer sur un créneau pour le réserver

Voter pour les listes de l'amicale

(screenshot en dehors des périodes de votes)

À l'attention des clubs

En tant que membre du bureau d'un club, vous pouvez administrer les informations affichées sur campus (et le site de l'Amicale) si vous satisfaites ces 3 conditions :

• vous êtes amicaliste (cotisé)
• vous avez accepté les CGU via le site
• la passation de votre club est correctement faites (i.e vous êtes bien indiqué dans le bureau sur le site)

Ces 3 paramètres peuvent être vérifiés via le site

Vous devez normalement voir apparaître votre club via l'interface du site de l'Amicale :

 

Gestion des informations du club

Via l'onglet principal, vous avez la possibilité d'éditer les liens, la catégorie de votre club, votre mail de contact, la description du club, votre logo...

Merci d'indiquer des liens et pas des noms de page pour instagram

Gestions des évènements

Vous avez la possibilité d'ajouter des événements qui vont s'afficher sur le site de l'Amicale, mais également sur l'application Campus ! 

Pour ajouter un événement, rien de plus simple :

1. Rendez-vous sur la page de gestion de votre club dans l'onglet "Evenements"
2. Cliquez sur "Créer un évenement"
3. Remplissez les informations
4. Cliquez sur "Créer l'évenement"
5. Dès lors que l'Amicale aura validé votre event, il sera disponible sur l'application et le site !

Sur le formulaires : les "*" indiquent les champs facultatifs et la case "Evenement public" est à cocher si vous souhaitez que votre évenement soit visible sur le site et l'application Campus !