Frankie-Bot

A simple Discord bot that posts random quotes from the TV show 'The Middle'
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

'Frankie-Bot' is a bot developed for members of 'The Middle' Discord server. Upon command, Frankie-Bot will post a random quote from either Frankie, Mike, Brick, Sue or Axl (and some other characters too!) into the bot-commands channel. Fans can recall their favourite 'The Middle' scenes and lines, and discuss these with others!

(back to top)

Built With

• Discord.js
• MongoDB
• Mongoose
• JavaScript

(back to top)

Getting Started

To get Frankie-Bot up and running locally on your machine, follow the prerequisite and installation steps below.

Prerequisites

• Node.js: You will need the latest version of Node.js, which you can download here.

• Environment variables: To keep secret information secure, you will need to create a .env file within the project directory. Once your .env file has been created, use a text editor to copy in your environment variables as shown in the example below. NOTE: You must write the MONGODB_SRV value exactly as it is written in the example. This will allow you access to the quotes database. You are required to input your own Discord token and channel ID.

  TOKEN = abcdefghij...
  MONGODB_SRV = mongodb+srv://all_users:1234@laurens-cluster.keqmo.mongodb.net/The-Middle
  CHANNEL = 1234567...
  

Running Frankie-Bot locally

Once you have followed the above prerequisite steps, you are ready to run the bot locally. To do so, simply open the Discord desktop application, and then type the following command into your terminal:

node .

Adding the bot to your server

If you don't want to run the bot locally, and simply wish to add Frankie-Bot to your Discord server, you can do so through the invite link

(back to top)

Usage

Once you've got Frankie-Bot up and running, simply type !quote in your specified Discord channel to see a randomly-generated quote.

(back to top)

Roadmap

• Posting a random quote
• The daily quote
• [] Saving new quotes

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Lauren Bassett - LinkedIn - laurenb252@outlook.com

Project Link: https://github.com/laurenbsst/Frankie-Bot

(back to top)

Acknowledgments

• Image of Frankie Heck. Copyright of Warner Bros. Entertainment Inc.
• Anson the Developer's Discord.js and MongoDB tutorials
• CodeLyon's Code Your Own Discord Bot (Basics)
• Discord.js docs

(back to top)