Skip to content

QUICKSTART.md

Latest commit

 

History

History
180 lines (139 loc) · 4.23 KB

QUICKSTART.md

File metadata and controls

180 lines (139 loc) · 4.23 KB

🚀 Guide de Démarrage Rapide - Stock Manager

Démarrage en 3 étapes

1️⃣ Prérequis

# Vérifier que Docker est installé
docker --version
docker-compose --version

Si Docker n'est pas installé:

  • Windows/Mac: Installer Docker Desktop
  • Linux: sudo apt-get install docker docker-compose

2️⃣ Lancer l'application

Option A: Script automatique (Linux/Mac)

./start.sh

Option B: Commandes manuelles (toutes plateformes)

docker-compose up -d

3️⃣ Accéder à l'application

Ouvrir dans votre navigateur:

📱 Installation sur mobile (PWA)

Sur Android (Chrome)

  1. Ouvrir http://localhost dans Chrome
  2. Menu (⋮) → "Installer l'application"
  3. L'icône apparaît sur l'écran d'accueil

Sur iOS (Safari)

  1. Ouvrir http://localhost dans Safari
  2. Bouton Partager → "Sur l'écran d'accueil"
  3. L'icône apparaît sur l'écran d'accueil

🎯 Premier usage

1. Ajouter des commerces

  1. Cliquer sur "Commerces" dans le menu
  2. "Nouveau commerce"
  3. Exemples: Auchan, Lidl, Carrefour, etc.
  4. Choisir une couleur pour chaque commerce

2. Ajouter des produits

  1. Retour sur "Produits"
  2. "Nouveau produit"
  3. Remplir les informations:
    • Nom: Lait demi-écrémé
    • Catégorie: Produits laitiers
    • Stock minimum: 2
    • Unité: L
    • Commerce: Lidl
    • Photo (optionnel): prendre/uploader une photo
    • Code-barres (optionnel): scanner ou saisir

3. Utiliser un produit

  1. Trouver le produit
  2. Cliquer "Utiliser"
  3. Indiquer la quantité
  4. ✅ Si stock < minimum → ajout automatique aux courses

4. Faire les courses

  1. Menu "Courses"
  2. Voir les produits groupés par commerce
  3. Au magasin: cocher les articles achetés
  4. ✅ Stock mis à jour automatiquement

🛠️ Commandes utiles

# Voir les logs en temps réel
docker-compose logs -f

# Arrêter l'application
docker-compose down

# Redémarrer après modifications
docker-compose up -d --build

# Reset complet (⚠️ supprime toutes les données)
docker-compose down -v
docker-compose up -d

# Initialiser avec des données d'exemple
docker-compose exec backend python init_sample_data.py

📊 Données d'exemple

Pour tester rapidement avec des données pré-remplies:

docker-compose exec backend python init_sample_data.py

Cela créera:

  • 5 commerces (Auchan, Lidl, Carrefour, Intermarché, Bio c'Bon)
  • ~25 produits typiques pour un ménage avec enfants
  • Certains produits seront déjà en rupture de stock

🔧 Dépannage

Port déjà utilisé

Si le port 80 ou 8000 est déjà utilisé, modifier docker-compose.yml:

ports:
  - "8080:80"  # Frontend sur port 8080
  - "8001:8000"  # Backend sur port 8001

La caméra ne fonctionne pas

  • Vérifier les permissions dans le navigateur
  • Sur mobile: utiliser HTTPS (requis pour la caméra)
  • Alternative: utiliser l'upload d'image

Images ne s'affichent pas

# Vérifier les permissions
docker-compose exec backend chmod -R 777 /app/uploads

Erreur de connexion backend

# Vérifier que le backend est lancé
docker-compose ps

# Voir les logs
docker-compose logs backend

💡 Astuces

  1. Scanner rapidement: Créer un raccourci vers l'icône scanner sur votre écran d'accueil

  2. Catégories suggérées:

    • Produits laitiers
    • Féculents
    • Conserves
    • Viande/Poisson
    • Fruits
    • Légumes
    • Boissons
    • Hygiène
    • Entretien
    • Goûter
    • Petit-déjeuner

  3. Unités courantes:

    • unité (pour comptage)
    • kg, g (poids)
    • L, ml (volume)
    • pack, paquet (emballages)

  4. Stock minimum pour famille nombreuse:

    • Lait: 3-4 L
    • Pâtes: 3-4 paquets
    • Pain de mie: 2-3 paquets
    • Yaourts: 2-3 packs
    • Céréales: 2-3 boîtes

📞 Support

  • 📖 Documentation complète: voir README.md
  • 🐛 Problème? Vérifier les logs: docker-compose logs
  • 💻 API: http://localhost:8000/docs pour explorer l'API

🎉 C'est prêt !

Vous pouvez maintenant gérer efficacement votre stock alimentaire et optimiser vos courses !

Bon usage de Stock Manager ! 🛒