{"id":17717398,"url":"https://github.com/achaak/toogoodtogo-bot","last_synced_at":"2025-05-01T02:32:09.788Z","repository":{"id":40463694,"uuid":"299386578","full_name":"Achaak/toogoodtogo-bot","owner":"Achaak","description":"TooGooToGo-Bot is a tool designed to help you stay informed about the availability of your favorite stores on the Too Good To Go platform. It sends notifications, allowing you to quickly find and purchase food products before they disappear.","archived":false,"fork":false,"pushed_at":"2024-01-30T12:47:01.000Z","size":288,"stargazers_count":53,"open_issues_count":0,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-01-31T11:35:35.849Z","etag":null,"topics":["api-integration","automation","discord-bot","docker","food-waste","nodejs","notification-tool","telegram-bot","too-good-to-go","windows-notifications"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Achaak.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-28T17:43:04.000Z","updated_at":"2024-01-31T11:35:35.850Z","dependencies_parsed_at":"2024-10-25T17:17:11.132Z","dependency_job_id":"1af3c50c-845d-4cbf-9aa9-4bdafd9df2c1","html_url":"https://github.com/Achaak/toogoodtogo-bot","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Ftoogoodtogo-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Ftoogoodtogo-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Ftoogoodtogo-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Achaak%2Ftoogoodtogo-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Achaak","download_url":"https://codeload.github.com/Achaak/toogoodtogo-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251812442,"owners_count":21647907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-integration","automation","discord-bot","docker","food-waste","nodejs","notification-tool","telegram-bot","too-good-to-go","windows-notifications"],"created_at":"2024-10-25T14:20:27.618Z","updated_at":"2025-05-01T02:32:09.754Z","avatar_url":"https://github.com/Achaak.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TooGooToGo-Bot\nTooGooToGo-Bot is a tool designed to help you stay informed about the availability of your favorite stores on the Too Good To Go platform. It sends notifications, allowing you to quickly find and purchase food products before they disappear.\n\n## Table of Contents\n- [Installation](#installation)\n- [Update](#update)\n- [Configuration](#configuration)\n  - [Discord](#discord)\n  - [Telegram](#telegram)\n  - [Desktop](#desktop)\n  - [Console](#console)\n- [Run with Docker](#run-with-docker)\n- [Run with PM2](#run-with-pm2)\n- [Change Log](#change-log)\n- [License](#license)\n\n## Installation\n### Prerequisites\n- [Node.js](https://nodejs.org) (\u003e=20.x.x)\n\n### Clone the Repository\n```bash\ngit clone https://github.com/Achaak/toogoodtogo-bot.git\ncd toogoodtogo-bot/\n```\n\n### Configure Environment Variables\n1. Make a copy of the sample environment file and enter your parameters:\n   ```bash\n   cp .env .env.local\n   ```\n2. Open `.env.local` in a text editor and fill in the required information.\n\n### Install Dependencies\n```bash\npnpm install\n```\n\n### Build the Project\n```bash\npnpm run build\n```\n\n### Start the Application\n```bash\npnpm start\n```\n\n## Update\nTo update the application, follow these steps:\n\n1. Get the latest files:\n   ```bash\n   git pull\n   ```\n\n2. Install any new dependencies:\n   ```bash\n   pnpm install\n   ```\n\n3. Rebuild the project:\n   ```bash\n   pnpm run build\n   ```\n\n## Configuration\n\u003cdetails\u003e\n  \u003csummary\u003eDiscord\u003c/summary\u003e\n\n  ### Discord\n  To set up Discord notifications, access the `.env.local` file in a text editor and provide the necessary value for the `NOTIFICATIONS_DISCORD_ENABLED` parameter.\n\n  #### Creating a Discord Webhook\n\n  1. Create a new Discord server or use an existing one.\n\n  2. Create a new channel\n\n  3. Create a new webhook in the channel settings and copy the URL provided. [See the Discord documentation for more information.](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)\n\n  4. Open the `.env.local` file in a text editor and fill in the `NOTIFICATIONS_DISCORD_WEBHOOK_URL` parameter.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eTelegram\u003c/summary\u003e\n\n  ### Telegram\n  To set up Telegram notifications, access the `.env.local` file in a text editor and provide the necessary value for the `NOTIFICATIONS_TELEGRAM_ENABLED` parameter.\n\n  To configure the bot, open the `.env.local` file in a text editor and specify the value for the `NOTIFICATIONS_TELEGRAM_BOT_TOKEN` parameter.\n\n  #### Creating a Telegram Bot\n\n  1. Open a Telegram chat with [BotFather](https://t.me/BotFather) and enter the **/start** command.\n\n  2. Select the **/newbot** command and follow the instructions to create a new bot. Take note of the token access provided.\n\n  3. Once your bot is created, multiple users can use it to receive notifications about their favorite stocks.\n\n  4. To start receiving notifications, send the **/start** command in your bot's conversation.\n\n  #### Commands\n  - **/start**: Starts Telegram notifications\n  - **/stop**: Stops Telegram notifications\n  - **/help**: Provides a list of usable commands\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eDesktop\u003c/summary\u003e\n\n  ### Desktop\n  To set up desktop notifications, access the `.env.local` file in a text editor and provide the necessary value for the `NOTIFICATIONS_DESKTOP_ENABLED` parameter.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eConsole\u003c/summary\u003e\n\n  ### Console\n  To set up console notifications, access the `.env.local` file in a text editor and provide the necessary value for the `NOTIFICATIONS_CONSOLE_ENABLED` parameter.\n\n  For clearing the console before each notification, open the `.env.local` file in a text editor and specify the value for the `NOTIFICATIONS_CONSOLE_CLEAR` parameter.\n\u003c/details\u003e\n\n## Run with Docker\nYou can also run the application using Docker. Follow these steps:\n\n1. Build the Docker image:\n   ```bash\n   docker build . -t \u003cyour desired username\u003e/togoodtogobot\n   ```\n\n2. Run the Docker image:\n   ```bash\n   docker run -p 3000:3000 -d \u003cyour desired username\u003e/togoodtogobot\n   ```\n\n## Run with PM2\nPM2 allows you to install the bot on a server and receive notifications 24/7. Follow these steps:\n\n1. Install PM2:\n   ```bash\n   pnpm install pm2 -g\n   ```\n\n2. Start the server:\n   ```bash\n   pm2 start start.sh\n   ```\n\n3. After logging in:\n   ```bash\n   pm2 ls # to see the process_id\n   pm2 attach your_process_id\n   # Press Enter to submit your registration\n   ```\n\n## Change Log\nSee the [CHANGELOG.md](https://github.com/Achaak/toogoodtogo-bot/blob/master/CHANGELOG.md) file for the change log.\n\n## License\nThis project is licensed under the [MIT License](https://github.com/Achaak/toogoodtogo-bot/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachaak%2Ftoogoodtogo-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fachaak%2Ftoogoodtogo-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fachaak%2Ftoogoodtogo-bot/lists"}