https://github.com/seanverano/reboost
Reboost is a Chrome extension with 2 core features, a hydration tracker for logging and tracking water intake and also a reminder for setting custom break alerts. ✨
https://github.com/seanverano/reboost
chrome-api chrome-extension react tailwindcss
Last synced: 12 months ago
JSON representation
Reboost is a Chrome extension with 2 core features, a hydration tracker for logging and tracking water intake and also a reminder for setting custom break alerts. ✨
- Host: GitHub
- URL: https://github.com/seanverano/reboost
- Owner: seanverano
- License: other
- Created: 2024-08-10T18:29:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-12T17:45:16.000Z (12 months ago)
- Last Synced: 2025-03-12T18:38:25.494Z (12 months ago)
- Topics: chrome-api, chrome-extension, react, tailwindcss
- Language: JavaScript
- Homepage: https://chromewebstore.google.com/detail/reboost/bdlffpdkioakgjjpmgpboogfiaegbpgp
- Size: 4.07 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Reboost**
Reboost is a Chrome extension with two features: a hydration tracker for logging water intake and a wellness reminder system for setting custom break alerts.
---
## **🧭 Navigation**
- [📋 Project Information](#seven)
- [❓ The Problem](#one)
- [🏛️ Project Architecture](#two)
- [🌟 Key Features](#three)
- [⚙️ Installation & Setup](#five)
- [🛠️ Technologies Used](#six)
- [📜 Changelog](#eight)
- [🤝 Contributing](#four)
---
### **Links**
- 🔗[**Chrome Web Store**](https://chromewebstore.google.com/detail/reboost/bdlffpdkioakgjjpmgpboogfiaegbpgp)
- 🔗[**Official Site**](https://reboost.fyi/)
- 🔗[**Chrome Extension Source Code**](https://github.com/seanverano/reboost)
- 🔗[**Official Site Source Code**](https://github.com/seanverano/reboost-site)
- 🔗[**Demo Video & Preview**](https://www.youtube.com/watch?v=g8RL_s4DbIY)
This project was solely developed by me, **Sean Dustin Verano**.
Development started around October 2024, this Chrome extension is actively maintained to ensure stability, add features, and enhance user experience. With a growing user base, continuous updates keep it stable, functional, and user-friendly.
---
Many people forget to stay hydrated and take breaks while working or studying on a computer. Similar tools, like mobile apps, are often too generic, cluttered, and easy to ignore.
A Chrome extension is more efficient and faster, keeping users focused without switching devices.
---
### **Frontend Overview**
The frontend is built using React + TailwindCSS. Below are the main routes:
- **`/`**: Homepage with an overview and navigation.
- **`/menu`**: Lets users choose between hydration tracking and reminders.
- **`/hydration-tracker`**: Users can log and track their water intake.
- **`/wellness-reminder`**: Allows users to set custom break reminders.
### Chrome Extension APIs & Required Permissions
Reboost utilizes the following Chrome APIs, which require specific permissions to function properly:
- **Alarms API (`alarms` permission)**: Schedules hydration reminders and break alerts in the background. The extension creates an alarm when a timer starts and listens for its completion to trigger notifications.
- **Storage API (`storage` permission)**: Stores hydration logs, reminder settings, and user preferences in local storage. This ensures that timers persist even after the extension is closed or the browser is restarted.
- **Notifications API (`notifications` permission)**: Sends non-intrusive pop-up notifications to remind users of their hydration goals and scheduled breaks. Notifications include interactive buttons for user acknowledgment.
---
### **Dual Self-Care Tools in One**
- **Hydration Tracker**: Log water intake and track progress toward daily hydration goals.
- **Wellness Reminders**: Set personalized break reminders (Eye Break, Hydration, Posture etc.) with custom notes.
- **Mini Pop-Up Notifications**: Get non-intrusive alert notification to stay on track without disrupting your workflow.
- **Persistent Tracking & Insights**: Review daily hydration logs and countdown timers for upcoming breaks.
### **Free, Lightweight & Privacy-Focused**
- **Lightweight & Efficient**: Runs smoothly without slowing down your browser.
- **No Account Required**: Use all features without signing up.
- **No Data Tracking**: Your data stay on your device (local storage).
- **Completely Free**: No hidden fees, subscriptions, or in-app purchases.
---
### **1. Clone the repository:**
```bash
git clone https://github.com/seanverano/reboost.git
```
### **2. Install dependencies:**
```bash
npm install
```
### **3. Build the extension:**
```bash
npm run build
```
### **4. Load the extension in Chrome:**
1. Open Google Chrome and navigate to `chrome://extensions/`
2. Enable **Developer Mode** (toggle in the top-right corner)
3. Click **Load unpacked**
4. Select the **build** folder inside your project
### **Alternative Installation**
If you prefer to install the extension directly, visit [**Reboost - Chrome Web Store**](https://chromewebstore.google.com/detail/reboost-track-water-intak/bdlffpdkioakgjjpmgpboogfiaegbpgp)
---
- React
- React Router
- Tailwind CSS
- React Icons
- Chrome Extension APIs (Alarms, Storage, and Notifications)
---
See the latest updates and improvements of this project in the [**Changelog**](https://github.com/seanverano/reboost/blob/main/CHANGELOG.md).
---
This project is open for contributions! Feel free to submit issues and pull requests.