Skip to content

vlameiras/tranquiled

Repository files navigation

TranquiLED

TranquiLED is a desktop productivity tool designed to enhance focus and promote relaxation. Using the subtle yet effective method of a gently pulsing LED on your screen, it mimics the rhythm of a calming heartbeat. This digital adaptation of a proven focus technique is ideal for those seeking to maintain concentration and reduce stress during work or study sessions.

Inspired by this HN post

Features

  • Adjustable Blinking LED: A screen-corner LED blinks rapidly and then gradually slows down, simulating a heartbeat rhythm.
  • Customizable Speed: Users can adjust the initial fast blinking rate and the rate at which it slows down.
  • Automatic Fade-Out: After reaching a calm pace, the LED fades away gently, providing a non-intrusive experience.
  • Multi-Display Support: Works across multiple monitors, placing an LED on each screen.
  • Global Keyboard Shortcut: Easily toggle the LED on or off with a simple keyboard shortcut.

Getting Started

Prerequisites

  • Node.js
  • Electron

Installation

  1. Clone the repo:
    git clone https://github.com/yourusername/TranquiLED.git
  2. Navigate to the project directory:
    cd TranquiLED
  3. Install NPM packages:
    npm install

Running the Application

To start the application, run:

npm start

Usage

After launching TranquiLED, an LED will appear in the corner of your screen(s). It will start with a fast blinking rhythm and gradually slow down to a calmer pace. Use the global keyboard shortcut Ctrl+Shift+L (customizable) to toggle the LED on or off.

Contributing

Contributions to TranquiLED are welcome!

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

A screen-corner LED that blinks rapidly and gradually slows to a calm pace, subtly guiding your brain into a focused and relaxed state

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published