https://github.com/altaks/drinkyourwater
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (4.0%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: Altaks
- License: mit
- Language: Rust
- Default Branch: main
- Size: 228 KB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 2
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
DrinkYourWater 🚰
Un bot Discord intelligent qui vous rappelle de boire de l'eau à intervalles réguliers pour maintenir une bonne hydratation.
🌟 Fonctionnalités
- Système de rappels d'hydratation : Rappels personnalisés pour boire de l'eau
- Fréquences multiples : Choisissez entre 30 minutes, 1 heure ou 3 heures
- Stockage persistant : Vos rappels sont sauvegardés dans une base de données SQLite
- Chargement automatique : Le bot restaure vos rappels existants au redémarrage
- Messages privés : Rappels personnalisés envoyés par message privé Discord
- Interface intuitive : Commandes slash simples et faciles à utiliser
🚀 Installation et configuration
Prérequis
- Rust (version 1.70+)
- Un bot Discord avec les permissions appropriées
- Un serveur Discord (guild)
Configuration
- Variables d'environnement : Créez un fichier
.envà la racine du projet :
env
DISCORD_BOT_TOKEN=votre_token_bot_discord
DISCORD_GUILD_ID=votre_id_serveur
- Construction et exécution :
```bash
Vérifier le code
just check
Construire le projet
just build
Lancer le bot
just run ```
📋 Commandes disponibles
/register
Enregistrez-vous (ou un autre utilisateur) pour recevoir des rappels d'hydratation.
Options :
- target (optionnel) : L'utilisateur à enregistrer. Si non spécifié, enregistre l'utilisateur de la commande.
Utilisation :
1. Exécutez /register ou /register @utilisateur
2. Choisissez votre fréquence de rappel préférée (30min, 1h, ou 3h)
3. Vous commencerez à recevoir des rappels à l'intervalle sélectionné
/unregister
Désinscrivez-vous des rappels d'hydratation.
Utilisation :
- Exécutez /unregister pour arrêter de recevoir des rappels
🗄️ Base de données
Le bot utilise SQLite pour stocker de manière persistante les données des rappels utilisateur :
- Fichier :
database.sqlite(créé automatiquement dans le répertoire du bot) - Table :
usersuser_id: ID utilisateur Discord (clé primaire)username: Nom d'utilisateur Discordreminder_frequency: Fréquence de rappel (ThirtyMin, OneHour, ThreeHours)last_reminded: Horodatage du dernier rappelcreated_at: Horodatage de l'enregistrement de l'utilisateur
🛠️ Développement
Commandes de développement
```bash
Vérifier le code
just check
Construire le projet
just build
Lancer le bot
just run
Linting et formatage
just lint
Nettoyer les fichiers de build
just clean ```
🔧 Détails techniques
- Framework : Serenity (wrapper Discord API)
- Base de données : SQLite avec rusqlite
- Runtime asynchrone : Tokio
- Système de logging : Tracing
- Gestion d'erreurs : Anyhow + ThisError
- Planification des tâches : tokio-schedule
💧 Messages de rappel
Le bot envoie différents messages selon la fréquence de rappel, par exemple : - 30 minutes : "💧 C'est l'heure de boire un peu d'eau ! 💧" - 1 heure : "💧 C'est l'heure de boire un verre d'eau ! 💧" - 3 heures : "💧 C'est l'heure de boire une grande quantité d'eau ! 💧"
🤝 Contribution
Les contributions sont les bienvenues ! N'hésitez pas à :
- Signaler des bugs
- Proposer de nouvelles fonctionnalités
- Soumettre des pull requests
📄 Licence
Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.
Restez hydratés et en bonne santé ! 💧✨
Owner
- Name: Altaks
- Login: Altaks
- Kind: user
- Location: France
- Twitter: 61Altair
- Repositories: 3
- Profile: https://github.com/Altaks
I'm currently 18yo, french student.
GitHub Events
Total
- Delete event: 4
- Issue comment event: 7
- Push event: 6
- Public event: 1
- Pull request review event: 5
- Pull request review comment event: 10
- Pull request event: 10
- Create event: 3
Last Year
- Delete event: 4
- Issue comment event: 7
- Push event: 6
- Public event: 1
- Pull request review event: 5
- Pull request review comment event: 10
- Pull request event: 10
- Create event: 3
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 0
- Total pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.33
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 6
Past Year
- Issues: 0
- Pull requests: 6
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.33
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 6
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (6)