Scrap-Dji / QUICK_START.md
joel
Initial deployment: Scrap-Dji with API
dfdddb1

🚀 QUICK START - Scrap-Dji pour Hugging Face

✅ Votre projet est PRÊT !

Tous les fichiers nécessaires ont été créés. Voici comment procéder :


📋 Étape 1 : Test Local (5 minutes)

# 1. Installer les dépendances
pip install -r requirements.txt

# 2. Lancer l'application
python app.py

✅ Ouvrez http://localhost:7860 dans votre navigateur
✅ Testez la recherche dans l'onglet "🔍 Recherche"
✅ Lancez un scraping de test dans l'onglet "🚀 Scraping"

Test de l'API

Dans un autre terminal :

python test_api.py

Résultat attendu : 6/6 tests réussis


🌐 Étape 2 : Test du Frontend (2 minutes)

  1. Gardez python app.py en cours d'exécution
  2. Ouvrez frontend_example.html dans votre navigateur
  3. Testez une recherche

☁️ Étape 3 : Déploiement sur Hugging Face (10 minutes)

3.1 Créer un Space

  1. Allez sur https://huggingface.co/new-space
  2. Remplissez :
    • Space name : scrap-dji
    • SDK : Gradio
    • Visibility : Private
  3. Cliquez sur Create Space

3.2 Pousser le Code

# Cloner le Space vide
git clone https://huggingface.co/spaces/VOTRE_USERNAME/scrap-dji
cd scrap-dji

# Copier TOUS les fichiers du projet Scrap-Dji
# (Remplacez /path/to/Scrap-Dji par le vrai chemin)
cp -r /path/to/Scrap-Dji/* .

# OU sur Windows PowerShell :
# Copy-Item -Path "C:\Users\MSI\Desktop\Scrap-Dji\*" -Destination "." -Recurse

# Ajouter et pousser
git add .
git commit -m "Initial deployment: Scrap-Dji with API"
git push

3.3 Vérifier le Déploiement

  1. Attendez 2-3 minutes (build en cours)
  2. Vérifiez les logs dans l'onglet "Logs" du Space
  3. Une fois "Running" ✅, testez :
    • Interface : https://VOTRE_USERNAME-scrap-dji.hf.space/
    • API Docs : https://VOTRE_USERNAME-scrap-dji.hf.space/docs

🔌 Étape 4 : Intégrer dans Votre Frontend

Dans votre code frontend, remplacez l'URL :

// Avant (test local)
const API_URL = 'http://localhost:7860';

// Après (production)
const API_URL = 'https://VOTRE_USERNAME-scrap-dji.hf.space';

Exemple de Requête

// Recherche
const response = await fetch(`${API_URL}/api/search`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    query: 'économie togo',
    pays: 'Togo',
    limit: 20,
    fuzzy: true
  })
});

const data = await response.json();
console.log(data.results);

// Statistiques
const stats = await fetch(`${API_URL}/api/stats`);
const statsData = await stats.json();
console.log(statsData);

📚 Documentation Complète


🎯 Endpoints API Disponibles

Endpoint Méthode Description
/api/search POST/GET Recherche avec filtres
/api/stats GET Statistiques
/api/documents GET Liste paginée
/api/documents/{id} GET Document par ID
/api/health GET Health check
/docs GET Documentation Swagger

⚡ Fonctionnalités Clés

Recherche permissive : Tolère les fautes de frappe
Filtres : Par pays, langue
Scoring : Résultats classés par pertinence
12 sources : 8 Togo + 4 Bénin
API REST : 7 endpoints pour votre frontend
Interface Gradio : 4 onglets interactifs


🆘 Besoin d'Aide ?

  • Problème de build : Vérifiez les logs dans l'onglet "Logs" du Space
  • API ne répond pas : Vérifiez que le Space est "Running"
  • Base vide : Lancez un scraping depuis l'interface Gradio

🎉 C'est Tout !

Votre projet est production-ready. Suivez les étapes ci-dessus et vous serez déployé en 15 minutes ! 🚀

Bon déploiement ! 🌍