node-toogoodtogo-watcher - GitLite

KO | EN

gitlite — search

#python #react #ai #typescript #golang #rust #deep-learning #docker #windows #cli #pytorch #mcp #openai #open-source

node-toogoodtogo-watcher

(★ 410)

Node.js cli tool for monitoring your favorite TooGoodToGo businesses. Docker image and HomeAssistant addon available.

File Explorer

Download Latest Version (.zip)

- - docker-multiarch-publish.yml
  - npm-publish.yml
- dependabot.yml
- - apprise-notifier.js
  - console-notifier.js
  - desktop-notifier.js
  - homeassistant-mqtt.js
  - message-renderer.js
  - notifier.js
  - telegram-bot.js
- config.js
- console-login.js
- poller.js
- toogoodtogo-api.js
.dockerignore
.eslintignore
.eslintrc.json
.gitignore
.prettierignore
.prettierrc
config.defaults.json
Dockerfile
index.js
LICENSE
logo.png
package-lock.json
package.json
Procfile
README.md
release.ps1
release.sh

# Installation Guide

1. Get the code

git clone https://github.com/marklagendijk/node-toogoodtogo-watcher

Downloads the entire project code from GitHub to your computer.

cd node-toogoodtogo-watcher

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker run \

Runs the built image as an actual container.

my-docker-compose-stuff

Runs the command against the services defined in the compose file.

│ docker-compose.yaml

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-toogoodtogo-watcher [![GitHub license](https://img.shields.io/github/license/marklagendijk/node-toogoodtogo-watcher)](https://github.com/marklagendijk/node-toogoodtogo-watcher/blob/master/LICENSE) [![npm](https://img.shields.io/npm/v/toogoodtogo-watcher)](https://www.npmjs.com/package/toogoodtogo-watcher) [![Docker Pulls](https://img.shields.io/docker/pulls/marklagendijk/toogoodtogo-watcher)](https://hub.docker.com/r/marklagendijk/toogoodtogo-watcher)

Node.js cli tool for monitoring your favorite TooGoodToGo businesses. Notifications are shown when the stock of any of
the businesses changes. The following notification types are supported:

- [HomeAssistant addon](https://github.com/marklagendijk/ha-toogoodtogo-watcher/) & HomeAssistant MQTT integration.
- All the notification services that [Apprise](https://github.com/caronc/apprise) supports (See [#215](https://github.com/marklagendijk/node-toogoodtogo-watcher/issues/215)).
- Desktop notification
- Console output
- Interactive Telegram bot

See [below for Docker usage](#docker).

[![Open your Home Assistant instance and show the add add-on repository dialog with the repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fmarklagendijk%2Fha-toogoodtogo-watcher)

## Installation

1. Install Node.js 18.x or higher ([Windows](https://nodejs.org/en/download/current/)
   | [Linux](https://github.com/nodesource/distributions#debinstall) | [OSx](https://nodejs.org/en/download/current/)).
2. `npm install -g toogoodtogo-watcher`
3. `toogoodtogo-watcher config`. Optionally enable / disable certain notifications. See [Configuring the interactive Telegram bot](#configuring-the-interactive-telegram-bot) for instructions on
   setting up the Telegram notifications.
4. `toogoodtogo-watcher login --email mail@example.com`. Click the link in the login email (on PC, not on phone).
5. `toogoodtogo-watcher watch`

## CLI documentation

```
Usage: toogoodtogo-watcher <command>

Commands:
  config        Open the config file in your default editor.
  config-set    Set configuration options.
  config-reset  Reset the config to the default values.
  config-path   Show the path of the config file.
  login         Interactively login via a login email.
  watch         Watch your favourite businesses for changes.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
```

## Configuring Apprise notifications

[Apprise](https://github.com/caronc/apprise) is software for sending notifications. It supports many services.

### Running

The easiest way to run the watcher together with Apprise is to use the Docker Compose setup, specified below.

### Configuration

1. Find your notification service and read the Apprise documentation for that service.
2. Follow any prerequisite steps as specified in the documentation.
3. Create an 'url' in the format specified in the documentation.
4. Add the url to the "apprise.services" section and specify the 'format'.

## Configuring the interactive Telegram bot

1. Open a Telegram chat with `BotFather`.
2. Follow the instructions to create your own bot.
3. Copy the token and enter it in the configuration via `toogoodtogo-watcher config`, and set `enabled` to `true`.
4. Start the application `toogoodtogo-watcher watch`
5. Click the `t.me/BOTNAME` link from the `BotFather` chat message.
6. Press `BEGIN`. Your bot should greet you.
7. You can log in using the `/login` 'command'. E.g: `/login mail@example.com`.
8. The bot will send you notifications about the shops that you selected as 'favourite' in the TGTG app. Note: Multiple people can connect to the bot to get updates about these favorites.

## Displaying the notifications in the Windows notification center

By default Windows doesn't display the notifications in the notification center. You can enable this by doing the
following steps.

1. Go to 'notifications & actions settings' (`Windows key`, type 'notifications', `enter`)
2. Click on the 'toast' app at the bottom of the screen.
3. Enable the 'show in action center' checkbox.

## Docker

Note: the Docker image is a multiarch image. So it will also work on Raspberry Pi's.

### Docker run

1. Create a directory to store the config file and copy
   the [config.defaults.json](https://github.com/marklagendijk/node-toogoodtogo-watcher/blob/master/config.defaults.json)
   into `YOUR_FOLDER/config.json`. See above for instructions on how to configure the application. Make sure that the
   folder has the correct permissions, e.g. run chmod -R o+rwx config/ or you might get access denied errors on the file
   system. The app needs read/write access on the configuration file, e.g. to store token received in it.
2. Run the following command to login, using the configured email address. Example: a user `john` who stored the config
   in `~/toogoodtogo-watcher/config.json`:

```
docker run \
 -i \
 --name toogoodtogo-watcher \
 --rm \
 -v ~/toogoodtogo-watcher:/home/node/.config/toogoodtogo-watcher-nodejs \
 marklagendijk/toogoodtogo-watcher login --email email@example.com
```

3. Run the following command to start watching.

```
docker run \
 --name toogoodtogo-watcher \
 --rm \
 -e TZ=Europe/Amsterdam \
 -v ~/toogoodtogo-watcher:/home/node/.config/toogoodtogo-watcher-nodejs \
 marklagendijk/toogoodtogo-watcher watch
```

### Docker Compose

1. Create the following directory structure.
   ```
   my-docker-compose-stuff
   │   docker-compose.yaml
   │
   └───toogoodtogo-watcher
       │   config.json
   ```
2. Copy
   the [config.defaults.json](https://github.com/marklagendijk/node-toogoodtogo-watcher/blob/master/config.defaults.json)
   to `toogoodtogo-watcher/config.json`. See above for instructions on how to configure the application.
3. Use the command as explained under 'Docker run' above to login using the configured email address.
4. Create a file `docker-compose.yaml`
   ```yaml
   version: "3"
   services:
     toogoodtogo-watcher:
       image: marklagendijk/toogoodtogo-watcher
       restart: unless-stopped
       environment:
         - TZ=Europe/Amsterdam
       volumes:
         - ./toogoodtogo-watcher:/home/node/.config/toogoodtogo-watcher-nodejs

# This will make Apprise reachable on apprise:8080 for the other Docker Compose containers
     apprise:
       image: caronc/apprise:latest
     # Enable these to make Apprise reachable from outside Docker
     # ports:
     #   - "8080:8080"
   ```