Files
EverShelf/README.md
T
morgane bcbdf669a1
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
Actualiser README.md
2026-06-27 16:28:06 +00:00

77 lines
1.9 KiB
Markdown

---
### 🐳 Déploiement via Portainer
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
# Bring! (optionnel)
BRING_EMAIL=email@example.com
BRING_PASSWORD=motdepasse
# Sécurité API
API_TOKEN=
# Nettoyage automatique
RECIPE_RETENTION_DAYS=7
TRANSACTION_RETENTION_DAYS=90
```
---
## 🔒 Vie privée
EverShelf est conçu pour fonctionner en auto-hébergement :
- Pas de compte obligatoire
- 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 l'utilisateur
---
## 🛠️ Développement
Technologies principales :
- PHP
- SQLite
- JavaScript
- HTML/CSS
- Docker
---
## 📜 Licence
Projet sous licence MIT.
---
## 🙏 Crédits
Ce fork, **EverShelf for Ricardo**, est maintenu par Morgane pour servir de système de gestion de stock/recettes à l'application **Ricardo**.
Projet original :
https://github.com/dadaloop82/EverShelf
Ce dépôt contient des améliorations et adaptations personnelles, incluant un système d'export/import avec fusion intelligente des données.