🏆 KilnHackathon - Programme de Points 🎯

KilnHackathon est un projet visant à améliorer la fidélisation des utilisateurs de vaults Defi sur Kiln. En utilisant un modèle "Points as a Service", notre solution récompense la fidélité des utilisateurs en attribuant des points basés sur leur participation au staking et à d'autres activités.

Sommaire

• Structure du projet
• Fonctionnalités
• Langages utilisées
• Installation
• Utilisation
• Auteurs

Structure du projet

Le projet est organisé comme suit :

KilnHackathon/
├── src/
│   ├── back/
│   │   └── api.py
│   └── front/
│       └── (fichiers front-end HTML, CSS)
└── README.md

• src/back/ : Contient les scripts backend, notamment le fichier test.py pour tester l'API.
• src/front/ : Contient les fichiers front-end (HTML, CSS) pour l'interface utilisateur.
• README.md : Documentation du projet.

Fonctionnalités

• Attribution de points : Calcul des points de fidélité en fonction des activités des utilisateurs sur les vaults.
• API Flask : Fournit une interface permettant de récupérer les points de staking via des requêtes HTTP.
• Interface utilisateur : Présente les informations sur les points et l'expérience utilisateur.

Langages utilisées

• HTML : Utilisé pour la structure des pages front-end.
• CSS : Utilisé pour le style et la mise en page.
• Python : Utilisé pour le traitement des données et l'API Flask.

Installation

1. Clonez le dépôt :

   git clone https://github.com/charlyppr/KilnHackathon.git

2. Accédez au répertoire du projet :

   cd KilnHackathon

3. Créez un environnement virtuel :

   python -m venv venv

4. Activez l'environnement virtuel :

   • Sur Windows :

     venv\Scripts\activate

   • Sur macOS/Linux :

     source venv/bin/activate

5. Installez les dépendances nécessaires :

   pip install Flask

6. Démarrez l'application Flask :

   python src/back/test.py

Utilisation

1. Assurez-vous que l'application Flask est en cours d'exécution.
2. Accédez à http://127.0.0.1:5000/ pour voir l'interface utilisateur.
3. Pour calculer les points de staking, utilisez le point de terminaison /points avec les paramètres wallet et vault.

Exemple de requête via cURL :

curl "http://127.0.0.1:5000/points?wallet=VOTRE_ADRESSE_WALLET&vault=VOTRE_ADRESSE_VAULT"

Auteurs

Simon Hamelin
Ewan Clabaut
Charly Pupier