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.
- Étapes Préliminaires
- Installation de Wamp64
- Clonage du Site
- Installation des Modules Python
- Ajout de la Base de Données
- Ajout des Variables d'Environnement
- Lancement du Serveur
- Auteurs
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
Pour installer Wamp64, suivez les étapes suivantes :
- Rendez-vous sur le site officiel de Wamp64 : Wamp64
- 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
- Une fois l'installation terminée, lancez WAMP64 depuis votre menu de démarrage.
- Ouvrez votre terminal
- Naviguez jusqu'à votre dossier www de Wamp64
cd C:\wamp64\www- Clonez le site depuis le repository
git clone https://github.com/hpktz/word_quest- Assurez vous d'avoir Python 3.8 ou supérieur installé sur votre machine
- Ouvrez votre terminal
- Naviguez jusqu'au dossier du site
cd C:\wamp64\www\word_quest\sources- Installez les modules nécessaires
pip install -r requirements.txt- Ouvrez votre navigateur et rendez-vous sur phpMyAdmin
- Connectez-vous avec les identifiants par défaut (login : root, mot de passe : vide)
- Créez une nouvelle base de données nommée
word_quest - Importez le fichier
sources/word_quest.sqldans 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.
- Créez un fichier
.envdans le dossierword_quest/sources - 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=- Lancez WAMP64 depuis votre menu de démarrage
- Ouvrez votre terminal
- Naviguez jusqu'au dossier du site
cd C:\wamp64\www\word_quest\sources- Lancez le serveur
python main.pyFé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.
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 :
- Allez dans le fichier python
sources/root.pyligne 35. - Changez la ligne en indiquant votre fuseau horaire selon le format UTC (
+XX:XX).