diff --git a/README.md b/README.md index 70418ab..b2bf45a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,151 @@ +# 🏠 EverShelf for Ricardo + +> Fork personnalisé d'EverShelf, adapté pour servir de backend stock/recettes à **Ricardo**, l'application bartender. Garde toutes les fonctionnalités d'EverShelf, avec des ajustements pour la gestion de bar (catégorie boissons, sous-catégories alcools, intégration directe avec Ricardo). + --- +[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE) +[![PHP](https://img.shields.io/badge/PHP-8.0+-blue.svg)](https://www.php.net/) +[![SQLite](https://img.shields.io/badge/SQLite-3-blue.svg)](https://www.sqlite.org/) +[![Docker](https://img.shields.io/badge/Docker-Compatible-2496ED.svg)](Dockerfile) + +--- + +## ✨ Fonctionnalités principales + +### 📦 Gestion des stocks + +- Inventaire alimentaire complet +- Gestion des emplacements : + - 🏠 Placard + - ❄️ Réfrigérateur + - 🧊 Congélateur + - 📍 Emplacements personnalisés, entièrement gérés depuis une page **🔧 Configuration** dédiée (ajout, modification, suppression sans toucher au code) +- Sous-catégorie dédiée aux boissons (vin, bière, spiritueux, soda, jus, eau...) pour filtrer et trier l'inventaire plus précisément +- Scan de codes-barres avec la caméra du téléphone +- Ajout rapide de produits +- Suivi des dates de péremption +- Gestion des produits ouverts +- Support des produits sous vide +- Détection des incohérences de stock + +--- + +## 🤖 Intelligence artificielle (Google Gemini) + +EverShelf peut utiliser l'IA pour : + +- 📸 Identifier un produit depuis une photo +- 📅 Lire automatiquement une date limite de consommation +- 🧊 Proposer un stockage adapté +- 🍳 Générer des recettes selon votre inventaire +- 💬 Répondre aux questions sur vos produits +- 🛒 Améliorer les suggestions de courses + +> L'IA est optionnelle. EverShelf fonctionne sans clé Gemini. + +--- + +## 🛒 Liste de courses intelligente + +- Création automatique depuis les ruptures de stock +- Prévisions de besoins +- Synchronisation avec Bring! +- Nettoyage automatique des doublons +- Suggestions d'achat personnalisées + +--- + +## 🍳 Mode cuisine + +- Recettes étape par étape +- Mode mains libres +- Synthèse vocale (TTS) +- Minuteurs automatiques +- Suivi des ingrédients utilisés +- Conseils anti-gaspillage + +--- + +## ♻️ Réduction du gaspillage + +- Suivi des aliments consommés ou jetés +- Analyse des pertes +- Alertes de péremption +- Suggestions pour utiliser les produits bientôt périmés + +--- + +## 🏡 Intégrations + +### Home Assistant + +Intégration native disponible : + +- Capteurs de stock +- Dates de péremption +- Liste de courses +- Calendrier des produits +- Actions personnalisées +- Suggestions de recettes IA + +Compatible avec une installation 100% locale. + +--- + +## 📱 Application mobile / PWA + +- Interface adaptée smartphone +- Installation comme une application +- Synchronisation multi-appareils +- Mode hors-ligne : + - consultation du stock + - actions mises en attente + - synchronisation automatique au retour réseau + +--- + +## 📺 Mode tablette (Kiosque Android) + +- Affichage plein écran +- Verrouillage kiosque +- Scan caméra +- Support TTS natif Android +- Découverte automatique du serveur +- Support des balances Bluetooth + +--- + +## 🚀 Installation rapide + +### Prérequis + +- PHP 8.0+ +- SQLite 3 +- Extensions PHP : + - `pdo_sqlite` + - `curl` + - `mbstring` + - `json` + +Docker est recommandé. + +--- + +### 🐳 Installation Docker (CLI) + +```bash +git clone https://git.mashome.fr/morgane/EverShelf.git +cd EverShelf +cp .env.example .env +nano .env +docker compose up -d +``` + +Puis ouvrez : +http://localhost:8080 + +--- ### 🐳 Déploiement via Portainer 1. Dans Portainer, va dans **Stacks** → **Add stack**