Smoke and the Water is a simple recurrent timer to help you to control how many cigarettes you 🚬 smoke, how many ☕️ coffee you drink and help you to remember you to drink pure clean 🚰 water.

Sure you can use it to remember daily stuff… but it was created for my own health needs 😬.

Configuration

Default configuration

The default configuration can be changed but can't be removed from the timers folder.

The default configurations are used only when a configuration is not set. For instance, you can set a single "endTime" for all your timers in the default.json and all timers will use this config. If you have a timer that needs a different "endTime", this configuration will overwrite the default.

Configuring your timers

Configure or edit the other timers located in the timers folder.

You should set:

Option	Type	Usage
title	String	used in the desktop alert
message	String	message for the alert used in all versions
name	String	the name used to show how many times you did that timer
endTime	String	when you want your timer to give the last alert in the day
bgColor	String	terminal background color
quantity	Number	the number of times you want this to be repeated
reminders	Array	list with the repeat timers in "hh:mm:ss" format. If you have less timers than the number you set in quantity, the rest of the reminders will be distributed until the endTime. The time must use hh:mm:ss format.
media	Object	object to define where the alerts should be displayed. If none is set, not even in the default .json, only terminal alert will be displayed.
token	String	Optional token that can be set for each timer individually

Example:

{
  "title": "Remember",
  "message": "🍰 The cake is a lie",
  "name": "lie remembered",
  "endTime": "23:30",
  "bgColor": "bgYellow",
  "quantity": 15,
  "reminders": [
    "00:30:00",
    "00:45:00",
    "01:00:00"
  ],
  "media": {
    "terminal": true,
    "computer": true,
    "phone": true
  },
  "token": "PushMe-App-Token"
}

Mobile push

To use the mobile push you need to install the app Push Me and get your key. In the app, click on the key to copy to the clipboard.

Then you need to copy or rename the .env.example file to .env and insert your key.

You can also set an separeted token for each timer, so each one has it's own name in the app end in the push notification.

Usage

First, install all needed packages with npm install --only=production (to install only production dependencies) or npm install (that will also install development dependencies).

Then, update the existing timers or create your own (JSON files in ./timers folder).

Finaly, run npm start and the app will run, alerting you in the computer and on your phone.

Example

Desktop alert

Mobile push

Terminal message

TODO

Mandatory

• Fix issue with timers finishing in the next day.
• Check if all needed config are filled or have default values.
• Create tests.
• Replace setTimeout for cron.
• Calculate the remaining alerts.
• Finish execution after all timers finish.
• Make sure quantity is smaller than the length of reminders.
• Look for performance issues.
• Let user define the first alert instead of setting when the app starts
• Individual push tokens for each timer

Nice to have

• Create better CLI interface
• Create config wizard
• Set individual messages for each timer (change reminders from an array to an object)
  • New reminders options to make it easier to crate your time table:
  • "fromBegining": "Time from the beginning"
  • "after": "Time after the previous, so, it's position matter"
  • "at": "On an exact time of the day (24:00)"

"reminders": [
    ["at", "18:00:00", "Prepare dinner"],
    ["fromBegining", "00:00:00", "Do something fun"],
    ["after", "00:30:00", "Read news"],
    ["fromBegining", "01:00:00", "Brush teeth and hair"],
    ["fromBegining", "01:05:00", "Search for jobs"],
    ["after", "01:00:00", "Check Trello"],
    ["after", "00:15:00", "Work"],
    ["after", "03:45:00", "Do something fun"]
  ]

• Possibility to disable alert on some days:

"enable": [
  "weekdays",
  "weekends",
  "sun",
  "mon",
  "tue",
  "wed",
  "thu",
  "fri",
  "sat",
  0, 1, 2, 3, 4, 5, 6, 7
]

Maybe in the future…

• Create Electron app
• Create Ionic app