Skip to content

Word Quest réinvente l'apprentissage de l'anglais en proposant une expérience ludique et immersive. Avec la possibilité de créer vos propres listes de vocabulaire et de vous plonger dans une série de mini-jeux captivants, l'apprentissage devient une aventure passionnante. Ce projet sera présenté aux Trophées NSI.

Notifications You must be signed in to change notification settings

hpktz/word_quest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Word Quest - Guide d'installation

Bienvenue dans le guide d'installation de Word Quest. Ce guide vous aidera à configurer votre environnement de développement et à lancer notre site avec succès. Si vous avez des questions ou rencontrez des problèmes, n'hésitez pas à nous contacter pour obtenir de l'aide supplémentaire.

Note importante : Peu de commits sont visibles sur ce répertoire. Nous avons dû changer de répertoire à cause d'un problème de visibilité de nos clefs API.

Table des Matières 📋

  1. Étapes Préliminaires
  2. Installation de Wamp64
  3. Clonage du Site
  4. Installation des Modules Python
  5. Ajout de la Base de Données
  6. Ajout des Variables d'Environnement
  7. Lancement du Serveur
  8. Auteurs

Étapes Préliminaires 🛠️

Avant de commencer, assurez-vous d'avoir les élements suivants :

  • Un ordinateur sous Windows (10 au minimum)
  • Une connexion internet stable et non restreinte
  • Python 3.8 ou supérieur
  • Avoir Git installé sur votre machine

Installation de Wamp64 📦

Pour installer Wamp64, suivez les étapes suivantes :

  1. Rendez-vous sur le site officiel de Wamp64 : Wamp64
  2. Lancez le programme d'installation et installez les composants nécessaires

Note : Voici une page github qui vous aideras à installer les composants nécessaires : Microsoft Visual C++ Redistributable Packages

  1. Une fois l'installation terminée, lancez WAMP64 depuis votre menu de démarrage.

Clonage du Site 🌐

  1. Ouvrez votre terminal
  2. Naviguez jusqu'à votre dossier www de Wamp64
cd C:\wamp64\www
  1. Clonez le site depuis le repository
git clone https://github.com/hpktz/word_quest

Installation des Modules Python 🐍

  1. Assurez vous d'avoir Python 3.8 ou supérieur installé sur votre machine
  2. Ouvrez votre terminal
  3. Naviguez jusqu'au dossier du site
cd C:\wamp64\www\word_quest\sources
  1. Installez les modules nécessaires
pip install -r requirements.txt

Ajout de la Base de Données 📊

  1. Ouvrez votre navigateur et rendez-vous sur phpMyAdmin
  2. Connectez-vous avec les identifiants par défaut (login : root, mot de passe : vide)
  3. Créez une nouvelle base de données nommée word_quest
  4. Importez le fichier sources/word_quest.sql dans la base de données

Note : La base contient des données de base pour le site (utilisateurs, scores, etc.). Cela permet de tester l'environnement complet du site.

Ajout des Variables d'Environnement ⚙️

  1. Créez un fichier .env dans le dossier word_quest/sources
  2. Modifiez les variables d'environnement pour correspondre à votre configuration
FLASK_SECRET_KEY=<VOTRE_CLE_SECRETE> # Clé secrète Flask (valeurs aléatoires recommandées)
COLLINS_API_KEY=<VOTRE_CLE_API_COLLINS> # Clé API Collins Dictionary
GOOGLE_SEARCH_API_KEY=<VOTRE_CLE_API_GOOGLE> # Clé API Google Custom Search Engine
GOOGLE_SEARCH_ENGINE_ID=<VOTRE_ID_MOTEUR_RECHERCHE_GOOGLE> # ID du moteur de recherche Google
EMAILING_SERVICE_PASSWORD=<VOTRE_MOT_DE_PASSE_EMAILING_SERVICE> - Mot de passe du compte de messagerie
EMAILING_SERVICE_TOKEN=<VOTRE_TOKEN_EMAILING_SERVICE> # Token Google Cloud pour taches Cron. Permet d'envoyer une requête POST à notre API de manière sécurisée
DIRECTORY_PATH= # - Laisser vide (Est utile si vous lancez le site depuis un autre dossier)
DB_HOST=localhost
DB_NAME=word_quest
DB_USERNAME=root
DB_PASSWORD=

Lancement du Serveur 🚀

  1. Lancez WAMP64 depuis votre menu de démarrage
  2. Ouvrez votre terminal
  3. Naviguez jusqu'au dossier du site
cd C:\wamp64\www\word_quest\sources
  1. Lancez le serveur
python main.py

Félicitations ! Vous avez maintenant configuré votre environnement de développement et lancé notre site avec succès. 🎉

Si vous rencontrez des problèmes ou avez des questions, n'hésitez pas à nous contacter pour obtenir de l'aide supplémentaire.

Gestion du fuseau horaire ⏱️

Par défaut, le fuseau horaire de la base de données est à UTC +01:00 (heure de Paris). Si votre fuseau horaire n'est pas celui-ci, il est important de le changer. Pour ce faire :

  1. Allez dans le fichier python sources/root.py ligne 35.
  2. Changez la ligne en indiquant votre fuseau horaire selon le format UTC (+XX:XX).

Auteurs 📝

  • Hippolyte Pankutz - Développeur - hpktz
  • Abel Haller - Développeur - Abelouuu

About

Word Quest réinvente l'apprentissage de l'anglais en proposant une expérience ludique et immersive. Avec la possibilité de créer vos propres listes de vocabulaire et de vous plonger dans une série de mini-jeux captivants, l'apprentissage devient une aventure passionnante. Ce projet sera présenté aux Trophées NSI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published