readme_extension.md

Other Ways of Running

Easily run the tool via Docker

This is the easiest way to get going, if you have Docker installed. Just download the reminder image by issuing the following commands:

Using Script:

Make sure first to clone the repo and cd into it.

# pull latest reminder image, make sure ~/reminder directory exists, and run the tool
. ./scripts/run_via_docker.sh

# run the tool (just run, without pulling image and other initialization steps)
. ./scripts/run_via_docker.sh fast

Directly using docker command:

# pull the image (or get the latest image)
docker pull goyalmunish/reminder

# make sure the directory for the data file exists on the host machine
mkdir -p ~/reminder

# spin up the container, with data file shared from the host machine
docker run -it --rm --name reminder -v ~/reminder:/root/reminder goyalmunish/reminder

For subsequent runs, better add the below alias to ~/.bashrc ( or ~/.zshrc, etc), so that you can invoke the tool, just by typing reminder (or any other alias that you prefer):

# define the alias
alias reminder='docker run -it --rm --name reminder -v ~/reminder:/root/reminder goyalmunish/reminder'

Then, run the tool using reminder command.

Non-Docker Setup

Check for available installers on releases page. Otherwise,

Install go

On Mac, you can just install it with brew as:

brew install go@1.18

For other platforms, check official go download and install guide.

Check installed version:

go version

Install the tool (optional)

Clone the repo:

git clone git@github.com:goyalmunish/reminder.git

If this results in Permission issues, such as git@github.com: Permission denied (publickey)., then either you Setup Git or just use git clone https://github.com/goyalmunish/reminder.git instead.

Install the tool as:

# cd into the local copy of the repo
cd reminder

# install the tool
go install ./cmd/reminder

# move the binary to /usr/local/bin/
mv ${GOPATH}/bin/reminder /usr/local/bin/reminder

Run the tool

If you have installed the tool, and your go/bin path is alreay in PATH, then you can just run it as:

reminder

Otherwise, you can just run it as (without installing, directly from clone of the repo):

# cd into the local copy of the repo
cd reminder

# running the tool using `make`
make run

# or as
go run ./cmd/reminder