Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.46 KB

README.md

File metadata and controls

73 lines (46 loc) · 2.46 KB

Recipe Bot is a Discord Bot created by @TylerJenningsW and @MichaelLillis using Python, Firebase for database handling, and Nextcord as a Discord API wrapper.

NOTE: This project is meant to be a learning experience, as both authors had limited knowledge of Python and Firebase going into the project.

Installation 💻

Run the following commands in terminal/command prompt:

pip install pyrebase
pip install pyrebase4
pip install nextcord
pip install python-dotenv

Change the following rules in your firebase realtime database:

{
  "rules": {
    ".read": true,
    ".write": true,
    	"Recipes":{
        ".indexOn":["Recipe","Ingredients","Instructions","Date created","Author"]
      }
  }
}

Configuration ⚙️

• Insert your discord bot token and your server id into the .env
• Follow the Firebase documentation to setup your database config for the database.py
• Replace the firebase config in the database.py file with yours
• Run main.py

Commands 📝

Recipe bot is very simple to use! There are only a few basic commands you'll need to know.

Add a recipe through the modal popup:

/Recipe add

Find a recipe stored in the database by recalling the user or recipe name:

/Recipe find [user or recipe name]

Return all recipes:

/Recipe all

Delete a recipe you created:

/Recipe delete [name]

Screen Shots 📷

blpow1g jk4KU4y

Links 🔗

Firebase - Free database hosting/handling+

Nextcord - Discord API

Discord - VoIP and instant messaging platform

Python - Programming language