chairemobilite/od_dependanceauto repository overview

⁠Enquête sur la dépendance auto 2024

⁠Installation

Pour installer, il faut d'abord aller chercher le code de ce répertoire, ainsi que celui de la plateforme correspondante:

git clone https://github.com/chairemobilite/od_dependance_auto_2024.git
git submodule init
git submodule update --init --recursive

La façon d'installer est la même que pour la plateforme evolution. Donc, suivre les instructions, sous la rubrique Installation, du README de la version d'evolution se trouvant dans le répertoire evolution qui a été téléchargée par la commande git submodule plus haut. Ce n'est peut-être pas la version la plus récente d'Evolution et les instructions sur la branche principale de la plateforme ne fonctionneront pas nécessairement.

Les instructions d'installation doivent s'exécuter à partir de la racine de ce répertoire et non dans le répertoire evolution.

⁠Rouler l'application

L'enquête est composée de 2 applications distinctes: une pour les participants web uniquement et l'autre pour les administrateur, intervieweurs, etc. Chaque application peut être exécutée indépendamment de l'autre et chacune est composée de 2 parties: le code client et le serveur.

⁠Application participant

Pour rouler l'application participant, il faut créer le paquet de déploiement du client et démarrer le serveur.

• yarn build:dev ou yarn build:prod permet de créer l'application client respectivement en mode développement, qui permet de facilement déboguer l'application, ou en mode production, qui est une version minifiée et plus performante.
• yarn start démarre le serveur sur le port 8080

Accéder à l'application participant au http://localhost:8080.

⁠Application administrative

Pour rouler l'application administrative, il faut créer le paquet client et démarrer le serveur sur un autre port.

• yarn build:admin:dev ou yarn build:admin:prod permet de créer l'application client, respectivement en mode développement et production.
• HOST=http://localhost:8082 yarn start:admin --port 8082 démarre le serveur sur le port 8082.

Accéder à l'application participant au http://localhost:8082

⁠Utiliser Generator

Ce projet utilise Evolution-Generator pour la création des enquêtes. Afin de générer une enquête, merci de suivre attentivement les instructions fournies dans la section How to Run du README d'Evolution-Generator⁠. Cette enquête utilise un fichier Excel directement à partir d'Office 365, n'oubliez pas de configurer adéquatement votre fichier .env pour qu'il corresponde aux paramètres du Generator.

# Download Excel file with Office365 and Sharepoint
SHAREPOINT_URL = "https://polymtlca0-my.sharepoint.com/personal/jerome_laviolette_polymtlus_ca/"
EXCEL_FILE_PATH = "/personal/jerome_laviolette_polymtlus_ca/Documents/Enqu%C3%AAte%20Segmentation/Questionnaire/OD_Segmentation_2024_Generate_Survey.xlsx"
OFFICE365_USERNAME_EMAIL = "Your user name, if allowed"
OFFICE365_PASSWORD = "You password, if allowed"

Pour ceux qui ont accès, voici le lien pour accéder au fichier Excel: OD_Segmentation_2024_Generate_Survey.xlsx⁠

⁠Mettre à jour l'application

Pour mettre à jour l'application, il suffit d'aller chercher la dernière version de la branche. Il peut y avoir des changements à la version d'Evolution utilisée, il faut s'assurer de le mettre à jour aussi.

git checkout main
git pull origin main
yarn reset-submodules
yarn
yarn compile
yarn migrate

⁠Contribuer à l'enquête

Pour contribuer à l'enquête et soumettre des changements, il faut passer par des pull requests.

• S'assurer d'avoir la version la plus récente de l'enquête, en suivant les instructions de la section précédente
• Créer une branche de travail: git checkout -b <nom de la branche>
• Effectuer les changements sur cette branche.
• Une fois la branche prête à être reviewée, l'envoyer upstream: git push origin <nom de la branche>
• Il est alors possible de créer une pull request sur github en allant sur le tab Pull requests du projet

Une pull request peut être un seul commit ou une branche complète. Dans ce dernier cas, chaque commit doit être indépendant et complet, avec un titre explicite. Les titres du genre Fix typo sont à proscrire.

Il est possible d'éditer un commit déjà fait pour le compléter ou fixer un typo. Si le commit à éditer est le dernier, simplement utiliser git commit --amend pour intégrer les changements actuels au commit.

Pour réécrire un historique de branche, par exemple pour ajouter à un commit précédent autre que le dernier, ou pour combiner des commits, il faut utiliser le rebase interactif git rebase -i HEAD~x où x est le nombre de commits à revoir.

Pour plus d'information sur les outils de git pour réécrire l'historique, consulter le manuel de git⁠.

⁠Mettre à jour le site en production

⁠Étape 1 : Mettre à jour la branche de production

git checkout main
git pull
git checkout perceptions
git merge main
# Assure-toi que le dernier commit est bien le commit attendu
git log
# Assure-toi de tout tester avant de pusher, car il n'y a pas de retour en arrière possible
git push origin perceptions

⁠Étape 2 : Ajouter un tag aux versions à déployer

git checkout perceptions
git pull origin perceptions
git tag -a r2024-08-05 -m "Release 2024-08-05"
git push origin r2024-08-05