QUICKSTART.md

🚀 QuickStart - Déployer en 5 Minutes

Guide ultra-rapide pour déployer votre application sur HuggingFace Spaces.

Prérequis (2 min)

1. Compte HuggingFace : https://huggingface.co/join
2. Git installé localement
3. Votre espace : https://huggingface.co/spaces/rinogeek/VirtualLabo

Option 1 : Via Script Automatisé (Recommandé)

Étape 1 : Préparer le repository

# Naviguer au dossier du projet
cd /chemin/vers/virtual_labo_chimique

# Initialiser git (si not déjà fait)
git init
git add .
git commit -m "Initial commit: Virtual Labo Chimique"

Étape 2 : Configurer le remote HuggingFace

# Ajouter le repository HuggingFace comme remote
git remote add origin https://huggingface.co/spaces/rinogeek/VirtualLabo

# ou si vous en avez déjà un
git remote set-url origin https://huggingface.co/spaces/rinogeek/VirtualLabo

Étape 3 : Déployer avec le script

# Rendre le script exécutable
chmod +x deploy.sh

# Lancer le déploiement
./deploy.sh

Le script va :

• ✓ Vérifier les fichiers requis
• ✓ Tester le build Docker
• ✓ Committer les changements
• ✓ Pousser vers HuggingFace
• ✓ Afficher le statut

Option 2 : Push Direct

# Cloner depuis HuggingFace
git clone https://huggingface.co/spaces/rinogeek/VirtualLabo
cd VirtualLabo

# Copier les fichiers du projet
cp -r /chemin/vers/virtual_labo_chimique/* .

# Committer et pousser
git add .
git commit -m "Initial: Virtual Labo with Docker"
git push origin main

Option 3 : Via Ligne de Commande

cd /chemin/vers/virtual_labo_chimique

# Ajouter le remote
git remote add huggingface https://huggingface.co/spaces/rinogeek/VirtualLabo || \
git remote set-url huggingface https://huggingface.co/spaces/rinogeek/VirtualLabo

# Committer les changements
git add .
git commit -m "Deploy: Virtual Labo Chimique" || true

# Pousser vers HuggingFace
git push huggingface main

Vérifier le Déploiement (2 min)

1. Allez sur l'espace

   https://huggingface.co/spaces/rinogeek/VirtualLabo
   

2. Vérifiez le statut

   • Status badge (en haut à droite)
   • Cherchez le point vert (running) ✓

3. Consultez les logs (si erreur)

   • Cliquez sur "Build logs"
   • Cherchez les messages d'erreur

4. L'app est live ! 🎉

   • Ouvrez-la directement depuis l'espace
   • Partagez le lien : https://huggingface.co/spaces/rinogeek/VirtualLabo

Dépannage Express

Le build prend trop longtemps

• Normal : 3-7 minutes la première fois
• Attendez patiemment
• Consultez les logs pour le statut

L'app affiche "Building"

• Attendez 5-10 minutes
• Rechargez la page
• Vérifiez les logs

Erreur "Application failed to start"

1. Cliquez sur Build logs
2. Cherchez le mot clé d'erreur
3. Consultez DEPLOYMENT.md pour solutions

Erreur 404 Not Found

• L'app existe mais les fichiers statiques ne chargent pas
• Vérifiez que npm run build fonctionne localement
• Vérifiez que server.js sert correctement les fichiers

Test Local Avant Déploiement

Pour être sûr que ça marche :

# Build docker
npm run docker:build

# Lancer en local
npm run docker:run

# Ouvrir dans navigateur
# http://localhost:7860

# Ctrl+C pour arrêter

Si ça marche localement → ça marchera sur HuggingFace ✓

Mettre à Jour l'Application

Après déploiement, pour mettre à jour :

cd /chemin/vers/virtual_labo_chimique

# Faire vos changements
# ...

# Committer et pousser
git add .
git commit -m "Update: Description du changement"
git push origin main

# HuggingFace rebuild automatiquement ✓
# Attendez 2-5 minutes

Fichiers Clés

Assurez-vous que ces fichiers sont présents :

✓ Dockerfile            (configuration Docker)
✓ server.js             (serveur HTTP)
✓ package.json          (dépendances)
✓ bun.lockb             (lock file)
✓ .dockerignore         (excusions)
✓ dist/                 (à générer par build)
✓ src/                  (code source)
✓ public/               (assets)

Configuration HuggingFace

La configuration est dans le README :

---
title: Virtual Laboratoire Chimique
emoji: ⚗️
colorFrom: blue
colorTo: purple
sdk: docker
port: 7860
---

C'est déjà configuré ✓

Variables d'Environnement

Pour ajouter des secrets :

1. Allez à Settings (⚙️) de l'espace
2. Cliquez sur Secrets
3. Ajoutez vos secrets (ex: GROQ_API_KEY)
4. Ils seront disponibles comme env vars

Plus d'infos : HF_CONFIG.md

Support

Pour plus d'aide :

• 📖 Guide complet : DEPLOYMENT.md
• ⚙️ Configuration : HF_CONFIG.md
• 📚 Documentation : README.md

Résumé

Étape	Commande	Temps
1. Init git	git init && git add . && git commit	1 min
2. Config remote	git remote set-url ...	30 sec
3. Déployer	./deploy.sh ou git push	1 min
4. Build HF	Automatique	3-5 min
5. Live !	Ouvrir l'URL	instant
TOTAL		~5-7 min

Pour Commencer

# Copier-coller à exécuter :

cd /chemin/vers/virtual_labo_chimique

# Step 1
git init
git add .
git commit -m "Initial: Virtual Labo"

# Step 2
git remote add origin https://huggingface.co/spaces/rinogeek/VirtualLabo 2>/dev/null || \
git remote set-url origin https://huggingface.co/spaces/rinogeek/VirtualLabo

# Step 3
git push origin main

# Voilà ! Attendez le build 🎉

---

Créé pour déployer en 5 minutes ⚡