polykhel / BirthdayBot

A discord bot to remember all birthdays

BIRTHDAYBOT

🔋 Usage

Once the bot is running and connected to your Discord channel and database you can use the following commands:

    * ~birthday <dd mm yyyy>: adds your birthday to the server
    * ~birthdays: brings all the birthdays in the server
    * ~nextBirthday: gets the next server's birthday
    * ~whatsMyBirthday: gets your birthday

⭐ Getting started

💻 Installation

Learn how to create a Discord bot and get a valid token here.

💾 To get started locally, follow these instructions:

1. Clone to your local computer using git.
2. Make sure you have Node installed; see instructions here.
3. Make also sure that you have MongoDB installed; see instructions here.
4. Create a copy of the .env.example file named .env found in ./src/config/.env.example and replace the placeholders with your bot token and MongoDB credentials
5. Run npm install to install all dependencies
6. Run npm run dev to start your server as development environment or npm run start for production

🏗️ Contribution Guidelines:

• fork and clone this repository
• Make a new branch using git checkout -b change/username
• Commit the desired changes to that branch
• Sign off your commits using git commit -s -m w/signoff
• Push your changes to the branch and open a pull request

🎃 Contributors Hacktoberfest 2020:

Tomas Sirio

Add yours!

👤 Who Am I?