README.md

Take a break

Take a Break is a Chrome extension that monitors and reminds you to take breaks periodically.

Features

Take a Break focuses on three important aspects during screen time. Look away from the screen, stay hydrated, and stretch your body. A default or recommended intervals are preset for different types of breaks that can be adjusted as per your requirements.

When it is time to take a break, the extension nudges an overlay on the active tab reminding you to take a break. This overlay can be dismissed before it is automatically removed after the break duration.

Additionally, you can enable push notifications that broadcast a notification at every break interval. This is especially useful when you perform tasks across the browser and other applications.

Running the project locally

Clone this repository, and simply run: yarn install Once the dependencies are installed, enable the developer mode in your Chrome browser by navigating to extensions > manage extensions & turn on developer mode.

Next, start the project by running yarn watch or yarn build (for a production build). Once the project is running, head back to the extension settings on the browser and click on "Load unpacked" and select the directory that houses this project.

Once the extension is loaded, you can play around, tweak the code, and see the changes instantly. If you're considering contributing to this project, kindly go through the contribution guidelines below.

Contribution

This project is open-sourced and accepting contributions. Kindly go through the contribution guidelines to get started.

Star this Repository 🌟

If you find this project useful or interesting, please consider showing your support by starring it. Your star helps raise the project's visibility and encourages further development.