Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugo-vrijswijk/tgtg
Never miss a TooGoodToGo box again!
https://github.com/hugo-vrijswijk/tgtg
scala selfhosted toogoodtogo typelevel
Last synced: 23 days ago
JSON representation
Never miss a TooGoodToGo box again!
- Host: GitHub
- URL: https://github.com/hugo-vrijswijk/tgtg
- Owner: hugo-vrijswijk
- License: gpl-3.0
- Created: 2022-06-11T00:57:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T10:14:33.000Z (7 months ago)
- Last Synced: 2024-04-02T12:16:54.574Z (7 months ago)
- Topics: scala, selfhosted, toogoodtogo, typelevel
- Language: Scala
- Homepage:
- Size: 108 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# TooGoodToGo Notifier
Never Miss a TooGoodToGo Box Again!
[](https://github.com/hugo-vrijswijk/tgtg/actions)
## Introduction
The TooGoodToGo Notifier is a simple yet powerful application designed to keep you updated about available boxes from your favorite stores on TooGoodToGo. It automates the process of checking for boxes and sends notifications to your preferred platforms whenever a box becomes available.
### Key Features
- Instant notifications when your favorite TooGoodToGo stores have boxes available.
- Flexibility to run as a one-time check or continuously with customizable intervals or CRON schedules.
- Option to utilize Redis for data storage, enabling stateless application runs.
## Getting Started
Before using the application, you'll need your TooGoodToGo user ID and refresh token. If you don't have them yet, you can obtain them with this command:
```bash
$ tgtg auth
```
For Docker users, you can run the command within a Docker container:
```bash
$ docker run -it --rm ghcr.io/hugo-vrijswijk/tgtg:latest auth
```
The command will guide you through obtaining your user ID and refresh token.
### Installation
You have two options for running the application:
1. **Download a Binary from the Latest Release**: [Release Page](https://github.com/hugo-vrijswijk/tgtg/releases)
2. **Use the Docker Image**:
```bash
$ docker run ghcr.io/hugo-vrijswijk/tgtg:latest
```
## Usage
The application operates in two modes:
1. **One-shot Mode**: Checks for boxes once and then exits.
2. **Server Mode**: Continuously monitors for boxes at [configured schedules](#schedules) without exiting.
To run the application, provide your TooGoodToGo user ID and refresh token as environment variables (`TGTG_USER_ID` and `TGTG_REFRESH_TOKEN`) or as arguments (`--user-id` and `--refresh-token`) and a [notification provider](#notifications).
For detailed information about available options, use the following command:
```bash
$ tgtg --help
```
### Notifications
Choose your preferred notification platform for available box alerts:
- Gotify: `--gotify-url` and `--gotify-token`.
- Pushbullet: `--pushbullet-token`.
- Pushover: `--pushover-token` and `--pushover-user`.
- Custom Webhook URL: `--webhook-url`
- This will send a POST request to the URL with a JSON body containing a `title` and `message`.
Each of these options can also be set as environment variables (in `SCREAMING_SNAKE_CASE`).
### Schedules
To enable server mode, specify intervals or CRON schedules for checking TooGoodToGo boxes:
- Intervals: `--interval ` (e.g., `--interval 5m` for every 5 minutes).
- CRON Schedules: `--cron ` (e.g., `--cron "0 0 0 * * ?"` for every day at midnight).
`tgtg` will run immediately, and then at the specified intervals or CRON schedules.
Intervals and CRON schedules can be combined as many times as needed. For example:
```bash
$ tgtg --interval 5m --cron "0 0 0 * * ?" --cron "0 0 12 * * ?"
```
### Utilizing Redis for Application State (advanced)
By default, `tgtg` stores authentication tokens and notification history cache in a local file named `cache.json`. For a stateless application, Redis can be used to manage this state.
To use Redis, specify the Redis host with the `--redis-host` option:
```bash
$ tgtg --redis-host
```
Alternatively, set the Redis host as an environment variable (`REDIS_HOST`).
## Development
The TooGoodToGo Notifier was developed using the following technologies:
- [Scala CLI](https://scala-cli.virtuslab.org/) (and [GraalVM](https://www.graalvm.org/))
- [Cats Effect](https://typelevel.org/cats-effect/) (and [FS2](https://fs2.io/))
- [Decline](https://ben.kirw.in/decline/)
- [Sttp](https://sttp.softwaremill.com/en/stable/)
- [Woof](https://github.com/LEGO/woof)
- [Circe](https://circe.github.io/circe/)
- [Rediculous](https://davenverse.github.io/rediculous/)
## Acknowledgments
This application drew inspiration from [tgtg-python](https://github.com/ahivert/tgtg-python). We express our gratitude to the developers of tgtg-python for their valuable contributions.