L'origine de ce projet découle du constat que de nombreuses personnes ne savent pas comment trier leurs déchets correctement, ce qui a un impact négatif sur l'environnement. Nous avons donc voulu créer une solution qui permettrait à chacun de devenir un écocitoyen responsable et de contribuer à la protection de notre planète.
Ekoroji est une application web conçue pour simplifier la recherche et la gestion des déchets. Elle est construite en utilisant le framework Flask et l'API OpenAI pour fournir des informations précises et fiables dans l'ensemble sur les différents types de déchets. Les utilisateurs peuvent rechercher des déchets spécifiques à l'aide d'un formulaire de recherche convivial et trouver des informations détaillées sur leur gestion, leur recyclage, leur réutilisation et leur élimination.
Ekoroji offre également aux utilisateurs la possibilité de contribuer à la base de données en ajoutant des informations sur les déchets. Ils peuvent ajouter, modifier ou supprimer les déchets existants pour maintenir la base de données à jour et pertinente.
En outre, Ekoroji propose des fonctionnalités de filtrage des résultats de recherche pour permettre aux utilisateurs de trouver des informations spécifiques en fonction du nom, de la description, etc. L'application fournit également des informations utiles sur les différentes options de gestion des déchets, telles que le tri et le recyclage.
En somme, Ekoroji est une application web pratique et complète pour la recherche et la gestion des déchets. Elle fournit des informations fiables et précises sur les différents types de déchets, tout en permettant aux utilisateurs de contribuer à la base de données et de trouver des informations spécifiques selon leurs besoins. Ekoroji encourage les utilisateurs à adopter une approche responsable dans la gestion de leurs déchets et à contribuer à la protection de l'environnement.
🗒️ : Les instructions suivantes ont été testées sur un système d'exploitation Windows. Cependant elles devraient fonctionner sur n'importe quel système d'exploitation tel que Linux ou Mac OS.
-
Assurez-vous d'avoir Python 3.11 installé sur votre système avant de commencer. Si ce n'est pas le cas, téléchargez-le depuis le site officiel de Python et installez-le.
-
Cloner le projet Ekoroji depuis GitHub en utilisant la commande suivante :
git clone https://github.com/Les-4-fantastiques/ekoroji.git
-
Naviguez vers le répertoire du projet avec la commande :
cd ekoroji -
Installez les bibliothèques requises avec la commande suivante :
pip install -r requirements.txt
Avant de pouvoir exécuter Ekoroji, il est important de noter que nous utilisons l'API OpenAI. Pour cela vous devez configurer votre clé d'API OpenAI. Voici les étapes à suivre :
⚠️ : L'utilisation de l'API OpenAI n'est pas obligatoire pour ce projet, cependant elle est nécessaire pour utiliser les fonctionnalités de génération de texte et d'image. Si vous ne souhaitez pas utiliser l'API OpenAI, vous pouvez passer à l'étape suivante.
🗒️ : Si vous ne possédez pas de clé d'API OpenAI, vous pouvez en obtenir une gratuitement en suivant les instructions ci-dessous.
-
Créez un compte sur la plateforme RapidAPI.
-
Accédez à la page de l'API OpenAI sur RapidAPI.
-
Abonnez-vous à l'API pour obtenir votre clé d'API.
-
Ouvrez le fichier
sources/app/openai/key_to_encryption.py. -
Lancez le code, rentrez votre clé d'API quand il vous la demande.
-
Copiez la clé d'API chiffrée retournée.
-
Ouvrez le fichier
sources/app/openai/key_api.txt. -
Remplacez la valeur déjà présente par la clé d'API chiffrée que vous avez copiée.
Maintenant, vous êtes prêt à exécuter Ekoroji en utilisant votre clé d'API OpenAI configurée.
🗒️ : Pour accéder à votre quota de demande à l'API, nous vous redirigeons vers cette page.
-
Vous pouvez maintenant exécuter l'application avec la commande suivante :
python sources/run.py
🗒️ : Assurez vous d'être dans le répertoire du projet avant d'exécuter cette commande.
-
Ouvrez votre navigateur et accédez à l'adresse http://localhost:5000 pour voir l'application Ekoroji en action.
-
Pour profiter de l'experience utilisateur sur notre site, vous devrez soit :
- Utiliser un écran vertical pour bénéficier de la version portrait.
🗒️ : Les fonctionnalités de l'application ne sont pas optimisées pour les écrans horizontaux.
- Utiliser le mode développeur
F12ouinspecterde votre navigateur en passant en mode téléphone pour bénéficier de la version portrait.🗒️ : Nous avons conçu le site avec un format 1080x2400 mais il est possible de l'utiliser sur d'autres formats tels que les formats de téléphone proposés par votre navigateur.
L'application Ekoroji permet de :
- Rechercher des informations sur les déchets en utilisant l'API OpenAI.
- Ajouter, modifier et supprimer des articles.
- Afficher la liste des articles.
- Rechercher les déchets à l'aide d'un formulaire de recherche.
🗒️ : Le site web n'a pas d'accès différent selon le rôle de l'utilisateur. Tous les utilisateurs peuvent ajouter, modifier et supprimer des articles.
- @untypequicode
Ethan FACCA: manager | développeur Python | développeur web - @ambre66160
Ambre FLORETTE: développeuse web - @benoiurlc
Benoît URLACHER: responsable de base de données - @ghostizzoks
KYLIAN ZHEN-CLAVERIE: développeur Python
