Installation - ApplETS/Notre-Dame GitHub Wiki

Technologies utilisées

Requis

  • Flutter SDK v3.32.0 ou supérieur
  • Openssl v1.1.1g ou supérieur
  • Java sdk 17

Configuration de Flutter

(Il est recommandé d'utiliser 7-Zip pour l'extraction du fichier)

  • Vérifier l'installation:
flutter --version
dart --version
flutter doctor
  • Ouvrir le menu des paramètres et s'assurer que les extensions Flutter et Dart sont bien installées.
  • Dans le menu des paramètres, se rendre dans la section "Languages & Frameworks".
    • Flutter: Ajouter le chemin vers le dossier Flutter.
    • Dart: Ajouter le chemin du dossier "flutter/bin/cache/dart-sdk" du dossier Flutter et cocher Notre-Dame comme projet supporté.

🏃 Premier Démarrage

1. Cloner le Projet

git clone https://github.com/ApplETS/Notre-Dame.git
cd Notre-Dame

2. Configurer les Variables d'Environnement

Télécharger le fichier env_variables à la racine du projet env_variables

# sur Linux
chmod +x ./scripts/decrypt.sh
chmod +x ./env_variables.sh
./env_variables.sh

# sur Windows dans une invite de commande GitBash
sh "env_variables.sh"

2. Installer les Dépendances

# Télécharger et compiler les dépendances
flutter pub get

# Générer le code (Freezed, Retrofit, etc.)
flutter pub run build_runner build --delete-conflicting-outputs

4. Démarrer l'Application

# Sur un émulateur/appareil
flutter run

# Ou spécifier le device
flutter devices
flutter run -d device_id

# Mode debug
flutter run -d device_id --debug

# Mode release
flutter run -d device_id --release

🛠️ Commandes Utiles

# Analyser le code
flutter analyze

# Formater le code
dart format lib/

# Générer le code
flutter pub run build_runner build --delete-conflicting-outputs

# Exécuter les tests
flutter test

# Exécuter les tests avec coverage
flutter test --coverage

# Nettoyer le cache
flutter clean

# Mettre à jour les dépendances
flutter pub upgrade

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

Comment contribuer au projet

Vous pouvez contribuer au projet en suivant les instructions de ce document

Cette page a été en partie générée avec l'aide de Claude Haiku 4.5

⚠️ **GitHub.com Fallback** ⚠️