Birthday Buddy Discord Bot

Hey there! I'm Birthday Buddy – your ultimate party pal here on Discord! 🎉 As a cool cat with a party hat and sunglasses, I bring a vibrant energy to your server and make sure every birthday is celebrated in style.

Birthday Buddy Bot is a Discord bot built with Discord.js to remind users of birthdays. Never miss a friend's special day again with Birthday Buddy Bot!

Features

🎈 Personalized Reminders: I'll send friendly reminders before each birthday, so you never miss a chance to spread some joy.
🎂 Interactive Commands: Just chat with me using intuitive commands to add, show, remove, or update birthdays effortlessly.

Commands

Birthday Buddy Bot supports the following commands:

add: Add a new birthday to the Buddy's memory.
show: Show the respective user birthday information, such as how many time until the next birthday.
update: Update information of an existing birthday reminder.
remove: Remove a birthday from Buddy's memory.

How to invite the Bot

For now Birthday Buddy Bot is only for selected servers to use, since was primarily created to friends, so if you want the bot on your server, please feel free to contact me!

Getting Started

To run Birthday Buddy Bot locally, follow these steps:

Clone the repository to your local machine:

$ git clone https://github.com/willy-r/bd-buddy-bot.git  # ssh git@github.com:willy-r/bd-buddy-bot.git

Navigate to the project directory:

$ cd bd-buddy-bot

Install dependencies using pnpm:

$ pnpm install

Create a .env file based on the .env.example provided.
Fill in the necessary environment variables in the .env file, such as your Discord bot token.
Start the bot locally:

$ pnpm start

Now, Birthday Buddy Bot should be up and running in your Discord server!

How to Contribute

Contributions to Birthday Buddy Bot are welcomed and appreciated. Here's how you can contribute:

Adding an Issue

If you encounter a bug, have a feature request, or want to suggest an improvement, please open an issue on the GitHub repository. Make sure to provide detailed information about the problem or feature request.

Resolving an Issue

If you want to work on an existing issue, follow these steps:

Assign yourself to the issue if it's not already assigned.
Fork the repository.
Create a new branch for your changes:

$ git checkout -b {issue-type}/issue-{issue-number}-{short-description}

Make your changes and commit them with clear and descriptive messages.
Push your changes to your fork.
Submit a pull request to the main repository, referencing the issue you addressed.

Once your pull request is reviewed and approved, it will be merged into the main branch. Thank you for contributing to Birthday Buddy Bot! 🎉

Created By

Birthday Buddy Bot was created by William Rodrigues.

willy-r / bd-buddy-bot