Skip to content

Repository files navigation

Remind2Rest

Remind2Rest is an interactive application tailored to promote better health habits, especially for those who spend extended periods in front of a computer. By leveraging visual cues and reminders, it helps users to take breaks, relax their eyes, and maintain proper posture.

Features

  • Eye Relax Reminder: Encourages users to look away from the screen periodically to reduce eye strain. The reminder flashes alternating colors to promote distance gazing.
  • Posture Reminder: Periodically reminds users to correct their sitting posture. Users can also rate their current posture, providing a feedback loop to improve over time.
  • Dynamic Plotting: Offers a visualization of posture ratings over time.
  • Cross-Platform Support:
    • Windows: Native support with always-on-top Tkinter overlays.
    • Linux (Wayland): High-performance GTK overlays with Layer Shell support.
    • Linux (X11): Reliable Tkinter fullscreen overlays.
  • Web Configurator: A modern web interface to adjust various settings, reload the service, and monitor status.
  • Service Integration: Supports running as a background service on both Windows (via Startup) and Linux (via systemd).

Dependencies

  • Python 3.8+
  • apscheduler
  • pillow
  • matplotlib
  • numpy
  • scipy
  • flask
  • PyGObject (Linux/Wayland only)

Setup

1. Clone the Repository

git clone https://github.com/Infraviored/Remind2Rest.git
cd Remind2Rest

2. Installation

Linux (Ubuntu/Debian)

Run the setup script to install dependencies, create a virtual environment, and set up a systemd user service:

python3 setup.py

This will:

  • Install system dependencies (python3-tk, python3-pil.imagetk).
  • Create a virtual environment in ~/.local/share/Remind2Rest/venv.
  • Set up a systemd service for the background reminder app.
  • Create a desktop entry for the Web Configurator.

Windows

Run the PowerShell installer script:

  1. Open PowerShell in the project directory.
  2. Run:
    .\Install-Remind2Rest.ps1

This will:

  • Create a virtual environment in %LOCALAPPDATA%\Remind2Rest\venv.
  • Install all requirements.
  • Add Remind2Rest to your Windows Startup folder.
  • Create a Desktop Shortcut for the Web Configurator.

3. Usage

Once installed, the background service will start automatically on login. You can manage your reminders via the Web Configurator:

  • URL: http://localhost:5000
  • Actions: Change reminder intervals, enable/disable modules, and reload the service.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages