PyMenuBOT/README.md

1.8 KiB

PyMenu

PyMenu is a discord bot to create grocery list

Feature

  • Add items to your list by sending a message to a channel within the GROCERY_LIST category.
  • Support for multiple lists, one for each channel.
  • Easily remove items from your list by clicking on the check mark reaction.

Screenshots

Planned feature

  • Set prices for items.
  • Specify quantities for items.
  • Customize the category name.
  • Add images.
  • Complete the Dockerfile for easy deployment
  • Implement statistics for nerd

Requirements

Installation

git clone https://git.chauvet.pro/starnakin/PyMenuBOT/
cd PyMenuBOT
  • Compile the project:
make
  • Launch the executable:
./PyMenu

Installation - Docker

  • Clone the project:
git clone https://git.chauvet.pro/starnakin/PyMenuBOT/
cd PyMenuBOT
  • Config the bot Edit the src/config.h file and set the discord bot token
  • Build the docker image.
docker build -t pymenu .
  • Run the docker
docker run --restart=always -d pymenu

Setting up on Your Discord Server

  • Add the bot to your server (using the official instance)
  • Create a category called listes-de-course
  • Inside this category, create channels for each of your grocery lists (e.g., Wallmart).
  • You can now start adding items to your lists by sending messages in the respective channels.