miguel-osuna / famous-quotes-bot

A discord.py bot for famous quotes.

Famous-Quotes-Bot

📖 Description

A discord.py bot for famous quotes.

🎯 Features

• Quote generation
• Bot information
• Help paginator

🔆 Visuals

💡 Getting Started

Follow the instructions below to work on the project on your local environment.

📋 Prerequisites

In case you don't use Docker, you'll need Git, Python 3.8, Pip and a Virtual Environment (in this case, Pipenv is used as a package manager and virtual environment).

💻 Installation

# Clone this repository
$ git clone https://github.com/miguel-osuna/Famous-Quotes-Bot.git

# Go into the repository from the terminal
$ cd Famous-Quotes-Bot

# Remove current origin repository
$ git remote remove origin

All dependencies are listed on the Pipfile.

🐋 Running project with Docker

This will run the project on your local environment.

Make sure to create a hidden folder like envs.example named .envs, with the same kind of environment variables.

docker-compose up -d --build

🚀 Deployment

This project includes a Procfile for Heroku, but can be deployed to any other host.

• Heroku: read the following tutorial to learn how to deploy to your heroku account..

🔧 Built With

• discord.py - Python Library for Discord API
• Quotes API - API built for quote generation

Project Documentation

For more, check the project documentation

🎭 Authors

• Miguel Osuna - https://github.com/miguel-osuna

📒 License

This project is licensed under the MIT License - see the LICENSE.md file for details.