Blink Eye

Blink Eye is a minimalist eye-care reminder app designed to reduce eye strain during extended screen usage. It also can be used as break time reminder app.

It provides customizable timers, full-screen popups, audio mute functionality, and a suite of additional features for a seamless user experience.

Features

• Customizable reminder timers.
• Rich library of customizable reminder screens.
• Full-screen popups with a 20-second countdown to prompt users to look away.
• Customizable dashboard for settings and preferences.
• Usage time tracking, can see daily, weekly, and lifetime usage stats.
• All future feature updates based on community feedback.
• Multilingual support. [Soon]
• Audio mute during reminders to enhance focus. [Soon]
• Workday setup, can specify worktime when reminders should show. [Soon]

Quick access links:

• Donate
• GitHub Repository
• Official Website

The 20-20-20 Rule

The 20-20-20 rule is a guideline to reduce eye strain caused by staring at screens for extended periods. It suggests that for every 20 minutes spent looking at a screen, you should take a 20-second break and focus your eyes on something at least 20 feet away.

Benefits:

• Reduces Eye Strain: Regular breaks help prevent eye fatigue and strain caused by prolonged screen time.
• Improves Focus: Taking short breaks can help maintain focus and productivity throughout the day.
• Prevents Dry Eyes: Looking away from the screen allows your eyes to blink more frequently, reducing the risk of dry eyes.
• Promotes Eye Health: Focusing on distant objects helps relax eye muscles and reduce the risk of developing vision-related issues.
• Boosts Productivity: By reminding users to take breaks, Blink Eye helps maintain high levels of focus and motivation. Short breaks lead to better mental clarity and energy, making it easier to tackle tasks efficiently.
• Increases Workflow Efficiency: With the break time reminder feature, Blink Eye ensures you're working in manageable intervals, reducing burnout and fatigue. It can help optimize your work routine by encouraging timely rest periods.
• Encourages Healthy Habits: Establishing a routine of taking regular breaks fosters a healthier work-life balance and prevents overexertion, improving your overall well-being.
• Customizable Break Times: Set your own intervals and break lengths to match your personal productivity style, making Blink Eye a versatile tool for users with different work schedules.
• Time Management Tool: Blink Eye can double as a productivity tool by encouraging structured break times, enhancing time management for both work and personal tasks.

License

• GNU General Public License (GPL) v3 + Additional Commercial Restrictions: Open-source use. GNU General Public License (GPL) v3 + Additional Commercial Restrictions
• Commercial License: For business purposes. Contact Noman Dhoni at [email protected] for licensing options.

Contact

For inquiries and support, please contact Noman Dhoni:

• Email: [email protected]
• Twitter: @nomandhoni

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

• Contributions for improving the dashboard, enhancing customizability, and adding new languages for multilingual support are particularly appreciated.

Follow the CONTRIBUTING.md for the instruction

Contribution Guide

Contributions are welcome! Feel free to open issues or submit pull requests.

Contributions for improving the dashboard, enhancing customizability, and adding new languages for multilingual support are particularly appreciated.

How to Contribute:

1. Fork the repository to your GitHub account.

2. Clone the repository to your local machine:

   git clone https://github.com/yourW-username/blink-eye.git

3. Create a new branch for your changes:

   git checkout -b my-branch

4. Make changes to the code.

5. Commit your changes:

   git commit -m "commit message"

6. Push your changes to the remote repository:

   git push origin my-branch

7. Create a pull request on GitHub.

Application Setup

Prerequisites

1. Tauri (for building the desktop app)
2. Rust (for building the desktop app)
3. Cargo (for package management)
4. Bun (for package management)

To build and run Blink Eye (Desktop App):

1. Install JavaScript dependencies:

   bun install

2. Change Directory:

   cd src-tauri

3. Install all Cargo dependencies:

   cargo install

4. Change Directory:

   cd ..

5. Run the app in development mode:

   bun run tauri dev

Website Setup

Prerequisites

3. Node JS (for package management)
4. Bun (for package management)

To build and run Blink Eye (Desktop App):

1. Change Directory:

   cd website

2. Install dependencies:

   bun install

3. Run the website in development mode:

   bun run dev

Support the Project

If you find Blink Eye helpful and want to support the project, you can buy me a coffee! ☕️

Your contribution helps keep the project alive and supports ongoing development. Thank you for your generosity!