README.fr.md

Projet Notre-Dame

Ce projet concrétise la quatrième version de l'application mobile ÉTSMobile pour Android et iOS. Il s'agit de portail principal entre l'utilisateur et l'École de technologie supérieure (ÉTS) sur appareils mobiles. ÉTSMobile est un projet open-source développé par les membres du club étudiant ApplETS. L'application offre notamment :

• L'accès aux notes d'évaluations
• L'accès aux horaires de cours
• Et bien plus...

Note: Ce guide est aussi disponible en: English

Technologies utilisées

• Flutter

Requis

• Flutter SDK v3.19.3 ou supérieure
• Openssl v1.1.1g ou supérieure
• Java sdk 17

Avant de démarrer le code

• Pour avoir accès a certaines fonctionnalités vous allez avoir besoin du certificat de SignetsAPI, la clef Google Drive., etc. , ces fichiers sont encrypté. Pour les décrypter vous allez devoir exécuter le script env_variables.sh (disponible uniquement sur le Google Drive du club),
• puis exécuter les commandes suivantes à la racine du projet:

chmod +x ./scripts/decrypt.sh
chmod +x ./env_variables.sh
./env_variables.sh

Démarrer le code

• Pour générer les classes pour l'internationalisation, exécuter les commandes suivantes:

flutter pub get

• Pour générer les mocks:

dart run build_runner build

Ajouter une variable d'environnement pour une API_KEY

• Pour ajouter le Google Maps API TOKEN et le GitHub API TOKEN, vous devez renommer le fichier .env.template en .env. Dans le fichier .env , vous devez ajouter le Google Maps API TOKEN et le GitHub API TOKEN.

Git hooks

Vous pouvez trouver dans le dossier .githooks l'ensemble des hooks pour git. Pour configurer git afin d'utiliser ce dossier, saisir la commande suivante:

git config core.hooksPath .githooks

⚖️ License

Ce projet est licencié selon la licence Apache V2.0. Voir le fichier LICENSE pour plus d'informations.