hacktobot

An open-source Discord bot to introduce and encourage participants to contribute to open-source projects and familiarize them with the bot development environment during Hacktoberfest 2022.

Requirements:

1. Python 3.8+
2. Git
3. Test server
4. Bot Account

Development Environment

We recommend creating a virtual environment to install and manage all the required dependencies.

# Creating the virtual environment
$ python3 -m venv .venv

# Activating the virtual environment
# POSIX
$ source .venv/bin/activate         # bash/zsh
$ source .venv/bin/activate.fish    # fish
$ source .venv/bin/activate.csh     # csh/tcsh
$ .venv/bin/Activate.ps1            # PowerShell Core

# Windows
C:\> .venv\Scripts\activate.bat     # cmd.exe
PS C:\> .venv\Scripts\Activate.ps1  # PowerShell

# Installing dependencies
$ pip3 install -r requirements.txt

# Running the bot
$ python3 __main__.py

Environment variables

Environment Variable	Description
PREFIX	Bot's command invocation prefix
BOT_TOKEN	Bot Token from the Discord developer portal
GITHUB_TOKEN	Personal access token for GitHub

Contributing to Hacktobot

For guidelines for contributions to this repository, see Contribution Guidelines.