EggCart is a Telegram Bot designed to manage your grocery list efficiently. Built with Node.js, SQLite, and Telegraf, it offers a simple and interactive way to add, remove, and manage items on your grocery list through Telegram.
- Add items to your grocery list with a simple Telegram command.
- Remove items from the list as you purchase them.
- View the entire list at any time.
- Clear the list with one command.
To get EggCart up and running, follow these steps:
-
Clone the repository
git clone https://github.com/ljgonzalez1/eggcart.git eggcart
-
Install the dependencies:
cd eggcart yarn install -
Setup your postgres environment
-
Create a
.envfile in the root directory and add your Telegram Bot API key and other required environment variables, like the one ontemplate.envTELEGRAM_TOKEN=1234567890:aA0bB1cC2dD3eE4fF5gG6iI7hH8jJ9kK0lL POSTGRES_HOST=localhost POSTGRES_PORT=5432 POSTGRES_USERNAME=admin POSTGRES_PASSWORD=password POSTGRES_DB_NAME=database
-
Set up the database tables:
yarn sequelize-cli db:create yarn sequelize-cli db:migrate
-
Start the bot:
yarn start
Once the bot is running, you can interact with it on Telegram using the following commands:
/add item1, item2, ...- Add items to your grocery list./remove item1, item2, ...- Remove items from your grocery list./list- Display the current grocery list./clear- Clear the grocery list.
- Original Author: Radical_Egg
- Primary Contributor and Maintainer: ljgonzalez1
EggCart is released under the ISC License. See the LICENSE file for more details.