Actualiser README.md
CI / PHP Syntax Check (push) Has been cancelled
CI / JavaScript Lint (push) Has been cancelled
CI / Docker Build Test (push) Has been cancelled
CI / Validate Translation Files (push) Has been cancelled
CI / Auto-merge develop → main (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled

This commit is contained in:
2026-06-18 06:49:37 +00:00
parent 6f1966113d
commit e746c3d05b
+56 -51
View File
@@ -1,40 +1,29 @@
🏠 EverShelf
# 🏠 EverShelf
«Gestionnaire de garde-manger auto-hébergé — Suivez vos stocks alimentaires, scannez vos produits, recevez des suggestions de recettes avec lIA et réduisez le gaspillage.»
> Gestionnaire de garde-manger auto-hébergé — Suivez vos stocks alimentaires, scannez vos produits, recevez des suggestions de recettes avec l'IA et réduisez le gaspillage.
Fork amélioré du projet original EverShelf avec corrections, améliorations dergonomie, intégrations supplémentaires et optimisations.
Fork amélioré du projet original EverShelf avec corrections, améliorations d'ergonomie, intégrations supplémentaires et optimisations.
---
<div align="center">🚀 Démo en ligne
"▶ Tester la démo" (https://evershelfproject.dadaloop.it/demo)
 · 
"🌐 Site du projet" (https://evershelfproject.dadaloop.it/)
 · 
"📖 Documentation" (https://github.com/dadaloop82/EverShelf/wiki)
La démo utilise des données fictives. Les fonctions IA sont activées. Les modifications sont isolées.
</div>---
""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)
[![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
## ✨ Fonctionnalités principales
📦 Gestion des stocks
### 📦 Gestion des stocks
- Inventaire alimentaire complet
- Gestion des emplacements :
- 🏠 Placard
- ❄️ Réfrigérateur
- 🧊 Congélateur
- 📍 Emplacements personnalisés
- 📍 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
@@ -44,9 +33,9 @@ La démo utilise des données fictives. Les fonctions IA sont activées. Les mod
---
🤖 Intelligence artificielle (Google Gemini)
## 🤖 Intelligence artificielle (Google Gemini)
EverShelf peut utiliser lIA pour :
EverShelf peut utiliser l'IA pour :
- 📸 Identifier un produit depuis une photo
- 📅 Lire automatiquement une date limite de consommation
@@ -55,21 +44,21 @@ EverShelf peut utiliser lIA pour :
- 💬 Répondre aux questions sur vos produits
- 🛒 Améliorer les suggestions de courses
«LIA est optionnelle. EverShelf fonctionne sans clé Gemini.»
> L'IA est optionnelle. EverShelf fonctionne sans clé Gemini.
---
🛒 Liste de courses intelligente
## 🛒 Liste de courses intelligente
- Création automatique depuis les ruptures de stock
- Prévisions de besoins
- Synchronisation avec Bring!
- Nettoyage automatique des doublons
- Suggestions dachat personnalisées
- Suggestions d'achat personnalisées
---
🍳 Mode cuisine
## 🍳 Mode cuisine
- Recettes étape par étape
- Mode mains libres
@@ -80,7 +69,7 @@ EverShelf peut utiliser lIA pour :
---
♻️ Réduction du gaspillage
## ♻️ Réduction du gaspillage
- Suivi des aliments consommés ou jetés
- Analyse des pertes
@@ -89,9 +78,9 @@ EverShelf peut utiliser lIA pour :
---
🏡 Intégrations
## 🏡 Intégrations
Home Assistant
### Home Assistant
Intégration native disponible :
@@ -106,7 +95,7 @@ Compatible avec une installation 100% locale.
---
📱 Application mobile / PWA
## 📱 Application mobile / PWA
- Interface adaptée smartphone
- Installation comme une application
@@ -118,7 +107,7 @@ Compatible avec une installation 100% locale.
---
📺 Mode tablette (Kiosque Android)
## 📺 Mode tablette (Kiosque Android)
- Affichage plein écran
- Verrouillage kiosque
@@ -129,44 +118,59 @@ Compatible avec une installation 100% locale.
---
🚀 Installation rapide
## 🚀 Installation rapide
Prérequis
### Prérequis
- PHP 8.0+
- SQLite 3
- Extensions PHP :
- "pdo_sqlite"
- "curl"
- "mbstring"
- "json"
- `pdo_sqlite`
- `curl`
- `mbstring`
- `json`
Docker est recommandé.
---
🐳 Installation Docker
### 🐳 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
```
---
⚙️ Configuration
### 🐳 Déploiement via Portainer
Exemple ".env" :
1. Dans Portainer, va dans **Stacks****Add stack**
2. Donne un nom à la stack (ex : `evershelf`)
3. Colle le contenu de ton `docker-compose.yml` dans l'éditeur web (ou utilise l'option **Repository** en pointant vers `https://git.mashome.fr/morgane/EverShelf.git` et le chemin du fichier compose)
4. Renseigne tes variables d'environnement dans la section **Environment variables** (ou via un fichier `.env` à la racine du repo)
5. Clique sur **Deploy the stack**
Pour mettre à jour après une modification de code :
- Va dans **Stacks** → ta stack → **Update the stack**
- Coche bien **« Re-pull image »** / **« Re-build image »** avant de valider — sinon Portainer redémarre le conteneur avec l'image déjà construite en cache, sans prendre en compte tes changements.
---
## ⚙️ Configuration
Exemple de fichier `.env` :
```env
# IA Google Gemini (optionnel)
GEMINI_API_KEY=votre_cle
@@ -180,10 +184,11 @@ API_TOKEN=
# Nettoyage automatique
RECIPE_RETENTION_DAYS=7
TRANSACTION_RETENTION_DAYS=90
```
---
🔒 Vie privée
## 🔒 Vie privée
EverShelf est conçu pour fonctionner en auto-hébergement :
@@ -191,11 +196,11 @@ EverShelf est conçu pour fonctionner en auto-hébergement :
- Pas de cloud imposé
- Données stockées localement
- SQLite comme base de données
- Les fonctions IA utilisent uniquement les services configurés par lutilisateur
- Les fonctions IA utilisent uniquement les services configurés par l'utilisateur
---
🛠️ Développement
## 🛠️ Développement
Technologies principales :
@@ -207,13 +212,13 @@ Technologies principales :
---
📜 Licence
## 📜 Licence
Projet sous licence MIT.
---
🙏 Crédits
## 🙏 Crédits
Projet original :