Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 2.28 KB

File metadata and controls

95 lines (72 loc) · 2.28 KB

⚡ QUICKSTART - 5 Minutes pour Démarrer

🎯 Installation Express

1. 🔑 Clé SSH (30 secondes)

  • Copiez cette clé : ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIyQC8hdWHJgc1sct+GFxnbuc9i6ac7LOHKlASiLavdJ croziors@github.com
  • GitHub.com → Settings → SSH keys → New → Collez → Save

2. 🐳 Docker Desktop (2 minutes)

3. 📥 Cloner (30 secondes)

git clone git@github.com:croziors/follower.git
cd follower

4. 🚀 Lancer (2 minutes)

Méthode Simple :

  1. Ouvrez Docker Desktop
  2. Glissez-déposez docker-compose.yml dans Docker Desktop
  3. Cliquez "Run"
  4. Attendez 2 minutes
  5. Cliquez "Open in Browser"

Méthode Pro :

docker-compose up -d --build

5. ✅ Tester (30 secondes)

  • Allez sur : http://127.0.0.1:3000
  • Console (F12) → Tapez : testFollower('TestUser')
  • Vous devriez voir l'animation !

🎮 Configuration Twitch

1. Credentials Twitch

{
  "twitch": {
    "clientId": "VOTRE_CLIENT_ID",
    "clientSecret": "VOTRE_CLIENT_SECRET"
  }
}

2. Configurez votre canal

  • Console navigateur (F12) :
fetch('/api/setup', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ username: 'VOTRE_NOM_TWITCH' })
})

🎬 OBS Setup

Source Navigateur :

  • URL : http://127.0.0.1:3000
  • 150x120px

🔄 Commandes Utiles

# Mise à jour
git pull origin main
docker-compose down && docker-compose up -d --build

# Logs
docker-compose logs -f

# Tests
curl http://127.0.0.1:3000/api/test/follower

🛠 Dépannage Rapide

Port occupé : Changez 3000:3000 en 3001:3000 dans docker-compose.yml

Docker ne démarre pas : Redémarrez Docker Desktop

Pas de followers : Vérifiez vos credentials Twitch

📚 Guides Complets

🎉 Vous êtes prêt ! L'overlay fonctionne sur http://127.0.0.1:3000