Code Monkey home page Code Monkey logo

nomandhoni-cs / blink-eye Goto Github PK

View Code? Open in Web Editor NEW
53.0 1.0 4.0 19.61 MB

Blink Eye: A minimalist eye care reminder app to reduce eye strain, featuring customizable timers :soon: , full-screen popups, audio mute :soon:.

Home Page: https://blinkeye.vercel.app

License: MIT License

Python 8.32% Inno Setup 3.80% Shell 1.24% TypeScript 79.63% HTML 0.54% JavaScript 3.09% CSS 2.37% Batchfile 0.99%
202020 202020-rule blink-eye eye-care productivity python windows save-eye eye eye-saver

blink-eye's Introduction

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 provides customizable timers, full-screen popups, audio mute functionalityfor a seamless user experience.

Features

  • Customizable reminder timers.
  • Full-screen popups with a 20-second countdown to prompt users to look away.
  • Audio mute during reminders to enhance focus.
  • Quick access links for easy navigation:

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.

Building the app

Windows

Using Script
  1. Clone the repository:

    git clone https://github.com/nomandhoni-cs/blink-eye.git
  2. Change Directory

    cd blink-eye/application
  3. Create and activate a virtual environment (optional):

    python -m venv .venv && .\.venv\Scripts\Activate.bat
  4. Run the build script:

    build_windows.bat
Manually
  1. Clone the repository:

    git clone https://github.com/nomandhoni-cs/blink-eye.git
  2. Navigate to the application directory:

    cd blink-eye && cd application
  3. Install the dependencies

    pip install -r REQUIREMENTS.txt
  4. Run the Application

    python blink_eye.py
  5. If you want to make .exe by yourself

    pyinstaller --name BlinkEye --onefile --windowed --icon=blink-eye-logo.ico --hidden-import plyer.platforms.win.notification blink-eye.py

Linux (Fedora Workstation)

  1. Clone the repository:

    git clone https://github.com/nomandhoni-cs/blink-eye.git
  2. Create and activate a virtual environment (optional):

    python -m venv .venv --system-site-packages && source ./.venv/bin/activate
  3. Run the build script:

    bash ./build_fedora.sh

Usage

  • The app will display a full-screen popup every 20 minutes with a 20-second countdown to remind you to look away and reduce eye strain.

  • Click the "Skip Reminder" button to close the popup for the current session.

  • Audio will be automatically muted during reminders and restored afterward.

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

blink-eye's People

Contributors

fluentmoheshwar avatar nomandhoni-cs avatar sayad-uddin-tahsin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

blink-eye's Issues

Do unittest in github actions

In the #29 PR, I've added a simple unittest script.

Adding a actions script on-push to run the unittests will prevent someone from accidentally merging a PR with failing tests.

Properly structure the repository for the ease of contribution

This same repo contains both the website and the app source code. It would be nice to have two separate repositories for that.
Now, all the source code of the app is in the root folder of the project.

But as this is a small app, making two separate folders would be enough I guess.
Then, those who want to contribute to the project can easily choose their section.

Like, I work with both Next.js and Python. But I would prefer to work with the development of the app with Python.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.