# Shui

**Repository Path**: testworkvm/Shui

## Basic Information

- **Project Name**: Shui
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: feature/linux
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-07
- **Last Updated**: 2025-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Shui - Smart Drink Water Reminder

<p align="center">
  <img src="public/screenshot-0.png" alt="Shui Screenshot" width="500"/>
</p>

A cross-platform drink water reminder app helping you stay hydrated 💪

## ✨ Features

- 🎯 Daily water intake goal setting
- ⏰ Smart time management
  - Custom reminder intervals
  - Workday-only reminders
  - Custom time ranges
  - Auto-pause when locked
- 🔔 Multiple reminder modes
  - Native system notifications
  - Tray countdown display
  - Global hotkey support
- 💡 Intelligent features
  - Automatic workday detection
  - Smart pause when locked
  - Quick actions in tray
  - App whitelist (pause during games/video calls)
- 📊 Data tracking
  - Daily water intake statistics
  - Break time analytics
  - Visual data dashboard

## 🖥 App Interface

<p align="center">
  <img src="public/screenshot-2.png" alt="Settings"/>
  <br/>
  <img src="public/screenshot-3.png" alt="Notification"/>
</p>

## 🚀 Getting Started

### Platform Support

- ✅ macOS
- 🚧 Windows (coming soon)
- 🚧 Linux (coming soon)

### Installation

Download latest version from [Releases](https://github.com/rock-zhang/Shui/releases/)

#### Note

If seeing "Shui is damaged" warning, run:

```bash
sudo xattr -r -d com.apple.quarantine /Applications/Shui.app
```

## 🛣 Development Roadmap

### Implemented

- [x] Core reminder system
- [x] Custom intervals
- [x] Workday detection
- [x] System tray integration
- [x] Global hotkeys
- [x] App whitelist management

### Planned

- [ ] Custom notification sounds
- [ ] Advanced analytics
  - [ ] Hydration trends
  - [ ] Break time reports
  - [ ] Data export
- [ ] Theme customization
- [ ] Multilingual support

## 🛠 Tech Stack

- [Tauri](https://tauri.app/) - Cross-platform framework
- [Next.js](https://nextjs.org/) - React framework
- [React](https://reactjs.org/) - UI library
- [Rust](https://www.rust-lang.org/) - Backend logic
- [shadcn/ui](https://ui.shadcn.com/) - UI components

## 📝 License

MIT License © 2024 [Slash]