Localisation

Application pour aider au choix de lieu d'habitation en fonction des coûts d'habitation et de transport

Table des matières

• Introduction
• Installation
• Configuration de l'environnement
• Rouler l'application
  • Application participant
  • Application administrative
• Mettre à jour l'application
• Contribuer à l'enquête
• Utiliser Generator
• Exécution des tests

Introduction

Cette plateforme est basée sur la plateforme Evolution pour construire le questionnaire

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/localisation.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.

Configuration de l'environnement

Si ce n'est pas déjà fait, copier le fichier d'exemple pour créer le fichier de configuration de l'environnement.

cp .env.example .env

N'oubliez pas de mettre à jour le fichier .env avec les bonnes valeurs pour votre environnement. Il faut probablement changer les valeurs suivantes:

PG_CONNECTION_STRING_PREFIX = "postgres://postgres:@localhost:5432/"
EXPRESS_SESSION_SECRET_KEY = 'MYSECRETKEY'
GOOGLE_API_KEY = "MYGOOGLEAPIKEY"
GOOGLE_API_KEY_DEV = "MYGOOGLEAPIKEYFORDEVELOPMENT"
MAGIC_LINK_SECRET_KEY = "MYVERYLONGSECRETKEYTOENCRYPTTOKENTOSENDTOUSERFORPASSWORDLESSLOGIN"
GOOGLE_OAUTH_CLIENT_ID = "GOOGLEOAUTHCLIENTID"
GOOGLE_OAUTH_SECRET_KEY = "GOOGLEOAUTHSECRETKEY"
RESET_PASSWORD_FROM_EMAIL = "admin@test.com"
MAIL_TRANSPORT_SMTP_HOST = "smtp.example.org"
MAIL_TRANSPORT_SMTP_AUTH_USER = "MYUSERNAME"
MAIL_TRANSPORT_SMTP_AUTH_PWD = "MYPASSWORD"
MAIL_FROM_ADDRESS = "example@example.org"

Rouler l'application

L'enquête est composée de 2 applications distinctes: une pour les participants web uniquement et l'autre pour les administrateurs, 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

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 à la plateforme

Pour contribuer à la plateforme et soumettre des changements, il faut passer par des pull requests.

• S'assurer d'avoir la version la plus récente de la plateforme, 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.

Utiliser Generator

Ce projet utilise Evolution-Generator pour la création du questionnaire. Afin de générer un questionnaire, merci de suivre attentivement les instructions fournies dans la section How to Run du README d'Evolution-Generator.