Skip to content

💧 A command-line app that remind you to drink water

Notifications You must be signed in to change notification settings

chanyatfu/stay-hydrated

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stay Hydrated

Overview

This application helps users track their water intake. It features a user-friendly interface with pages for main tracking, history, settings, tips, and app information.

Screenshot 2024-01-15 at 11 01 35 AM

Installation

To use Water Tracker CLI, clone the repository and install the dependencies:

git clone https://github.com/chanyatfu/stay-hydrated.git
cd stay-hydrated
bun install
bun start

Key Features

  • Persistence Storage: Ensures your data is saved and retrievable even after closing and reopening the app.
  • Background Tracking: Continues tracking your water intake even when not actively using the app.
  • System Notification for Water Intake: Provides system notifications to remind you when it's time to complete your current water bottle.
  • Interactive Water Bottle Display: Visual representation of water bottles to show your daily water intake.
  • Water Consumption Tracker: Tracks the total volume of water you have consumed during the day.

Navigation

Navigate between pages using the number keys.

  • Main Page(1): Shows current water intake and allows setting volumes.
  • History Page(2): Displays water intake history for the past 7 days.
  • Settings Page(3): Allows adjusting settings like bottle capacity and sound.
  • Tips Page(4): Provides helpful tips for using the app.
  • App Info Page(5): Shows version and release date of the app.

Known bugs

  • Need to change remaining water to consumed water, or the remaining water level won't be accurate when bottle capacity is changed
  • Need to add mechanism to reset data when date pass but app is still open

About

💧 A command-line app that remind you to drink water

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published