An open API service indexing awesome lists of open source software.

https://github.com/0xfederama/water-reminder

Taskbar and notifications app that reminds you to drink
https://github.com/0xfederama/water-reminder

app drink go golang hacktoberfest linux macos notifications

Last synced: 4 months ago
JSON representation

Taskbar and notifications app that reminds you to drink

Awesome Lists containing this project

README

          

# Water Reminder

[![Build Status](https://travis-ci.com/0xfederama/water-reminder.svg?branch=master)](https://travis-ci.com/0xfederama/water-reminder) [![Go Report Card](https://goreportcard.com/badge/github.com/0xfederama/water-reminder?)](https://goreportcard.com/report/github.com/0xfederama/water-reminder?) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

:droplet: :droplet: :droplet:

Remember to drink every 15/30/45/60 minutes with this simple app.

For now the app displays the icon in the notifications only in linux.

MacOS | Linux
:-------------------------:|:-------------------------:
![WR-MacOS](https://github.com/0xfederama/water-reminder/blob/master/.screenshots/water-reminder-macos.png) | ![WR-Linux](https://github.com/0xfederama/water-reminder/blob/master/.screenshots/water-reminder-linux.png)

# Installation

### MacOS

- Download the latest [release](https://github.com/0xfederama/water-reminder/releases) for MacOS (`.dmg` file)
- Move `Water Reminder.app` file in Applications
- Launch the app, then go into preferences, security and allow the app to be executed, since it is not trusted by Apple.
- To make the app run at startup open preferences, users, [your user], login items and add the app to the list

### Linux

- Download the latest [release](https://github.com/0xfederama/water-reminder/releases) for Linux (the simple `drink_linux` binary file) and place it wherever you want
- To make the app runnable from the applications grid, first launch it from the terminal, then you need to create `water-reminder.desktop` file in `$HOME/.local/share/applications` and copy this, changing [your username]
```
[Desktop Entry]
Name=Water Reminder
Exec=/path/to/drink_linux
Terminal=false
Type=Application
Comment=Remember to drink every 30 minutes
Icon=/home/[your username]/.config/water-reminder/water-glass.png
```
- To make the app run at startup (using `water-reminder.desktop` and if you have `gnome-tweak-tools` installed) you can open Tweaks and add Water Reminder to the startup applications. Otherwise, if you didn't create `water-reminder.desktop` or if you don't have `gnome-tweak-tools`, open "Startup Applications", press "Add" and in the command section type `path/to/drink_linux`. Give the app the name you want

# Build

To build from source, all you need to do is to install [Go](https://golang.org/dl/) (the latest version is ok), clone the repo (`go.mod` and `go.sum` files (Go modules) will install for you every Go library needed) and then build with `go build -o [name] drink.go lib.go`