Installation

Requirements

• A server with public endpoints
• Python 3.10.2 or above: Windows, MacOS, Linux
• Git

Clone this repository

$ git clone https://github.com/BURG3R5/github-slack-bot.git
$ cd github-slack-bot

Connect to GitHub

• Add <your-url>/github/events to your organization or repository's webhooks.
• Set "Content type" to application/json
• Check the "Send me everything" radio button

Connect to Slack

• Find and replace every instance of <your-url> in the provided manifest with whatever your server's URL is.
• Go to link and create a new app using the edited manifest.
• Install the app to your Slack workspace.

Environment variables

• Copy .env.sample to .env.
• Set DEBUG to 0 and the other variables to appropriate values.

Create a virtual environment

$ python -m venv venv  # Or, if your system contains both Python 2 and 3, use `python3`.

Activate your virtual environment

MacOS and Linux:

$ source venv/bin/activate

Windows:

> venv\Scripts\activate

Install dependencies

$ pip install -r requirements.txt  # Or, if your system contains both Python 2 and 3, use `pip3`.

Run the bot

$ python main.py  # Or, if your system contains both Python 2 and 3, use `python3`.