nomandhoni-cs / blink-eye

Blink Eye: A minimalist eye care reminder app for Windows, macOS, and Linux, to reduce eye strain, featuring customizable timers, full-screen popups, audio mute :soon:.
https://blinkeye.vercel.app
Other
66 stars 9 forks source link
202020 202020-rule blink-eye break break-timer cvs eye eye-care eye-saver eye-saving-app hacktoberfest linux mac macos productivity rsi save-eye windows

Blink Eye App logo

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

Quick access links:

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:

License

Contact

For inquiries and support, please contact Noman Dhoni:

Contributing

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

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

  1. Node JS (for package management)
  2. 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! ☕️

Buy Me A Coffee

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