From 5f1b52d7d1044b6fb2cc1bab504b80142790beff Mon Sep 17 00:00:00 2001 From: perco Date: Thu, 30 Apr 2026 14:05:35 +0200 Subject: [PATCH] Add README --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d4799f --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Todo / Mémos avec rappels Discord + +Application web de gestion de tâches avec rappels quotidiens via Discord. Chaque mémo non terminé génère une notification Discord à l'heure configurée, tous les jours, jusqu'à ce qu'il soit marqué comme fait. + +## Fonctionnalités + +- Créer des mémos avec titre, description et heure de rappel +- Rappel Discord quotidien à l'heure choisie tant que la tâche n'est pas faite +- Marquer comme fait / rouvrir / modifier / supprimer +- Onglet historique des tâches terminées + +## Stack + +- **Backend** : Python FastAPI + SQLite +- **Rappels** : APScheduler (vérifie chaque minute) +- **Notifications** : webhook Discord +- **Frontend** : HTML/CSS/JS vanilla +- **Déploiement** : Docker + Traefik + +## Déploiement + +```bash +cd /opt/container/memo +docker compose up -d --build +``` + +Accessible sur **https://todo.nas.percolouco.com** + +## Configuration + +Dans l'app, cliquer sur ⚙️ et coller l'URL du webhook Discord (Paramètres du canal Discord → Intégrations → Webhooks). + +## Structure + +``` +memo/ +├── app/ +│ ├── main.py # API FastAPI (routes CRUD) +│ ├── database.py # SQLite + initialisation schema +│ ├── scheduler.py # APScheduler — vérifie les rappels chaque minute +│ └── discord_notify.py # Envoi des notifications via webhook Discord +├── static/ +│ ├── style.css +│ └── app.js +├── templates/ +│ └── index.html +├── Dockerfile +└── requirements.txt +``` + +Les données (base SQLite) sont persistées dans `/opt/container/memo/data/`.