take-ten v1.1.2

Take-Ten

take-ten is a node.js CLI based timer to schedule breaks and send push notifications directly to your computer! It loosely follows the Pomodoro technique of working and taking breaks in-between.

Pre-requisites :

• Node.js : Installation guideline here.
• PM2 : PM2 is a process manager for running background tasks. take-ten requires pm2 to run notification daemon so it'll be installed automatically while running take-ten for the first time. Can be installed explicitly from here.
• Basic notification libraries/drivers to run node-notifier. These are mostly installed as defaults in various OS. List can be found here.

Installation

npm install take-ten -g

Usage:

To start take-ten , run take-ten start from command-line. To stop, run take-ten stop.

take-ten [options][command]

Options:
-V, --version output the version number
-h, --help display help for command

Commands:
start START background process for push-notification
stop STOP background process for push-notification
help [command] display help for command

after starting , user will be prompted as below,

1. Pick a work duration. take-ten will send a push-notification after this amount of time. default: 25 minutes

?   Pick Work Duration :  (Use arrow keys)
❯   25 Minutes
    1 Hour
    2 Hours

2. Pick a break duration. take-ten will send a push-notification after this amount of time informing the break session is over! default: 5 minutes

?   Pick Break duration :  (Use arrow keys)
❯   5 Minutes
    10 Minutes
    20 Minutes

3. Enter how many cycles of work-break set wll be needed. If something other than number is added, defaults to 2. default: 2

?   Enter Number of Work-Break Sets :  (2)

4. Any custom message to remind that break-time has began! default: Get up and Drink Water!

?   Enter a notification message :  (Get up and Drink Water!)

To be noted :

The app can be monitored/edited/stopped directly using pm2. For that, run pm2 ls and look for the process named notify. That process can be treated as a normal pm2 process.

Issues :

None that I know of till @1.1.0 . The app is very simple and straightforward at this stage. I am very new to JS and in app development altogether! so if there are any problems; I might have missed it! Please open an issue or submit pull request to fix/look into any problem 😊

Changelog

1.1.0@ 04.08.2020

Added :

1. Automated stop process. The notifier daemon will stop after all sets are complete. Will give a notification after stopping.
2. A cute dog picture will show as a notification picture showing you thumbs up for your hard-work!
3. Colored inputs and console messages.

Fixed :

1. Input glitch that showed the first input prompt twice.
2. Fallback value to set when entering anything other than number.
3. Error Handling.

Upcoming Features :

Custom work and break time ** Notification sound * Option to customize image, title and sound of the notification *