From b5c1e927828cdac0dd8de2afb9eb99b974c98f2c Mon Sep 17 00:00:00 2001 From: Arslaan Pathan Date: Fri, 17 Jul 2026 07:14:35 +1200 Subject: Running locally --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index eb48c6a..c67e7db 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,11 @@ --- > Note: this project was made for [Hack Club Doppel](https://doppel.hackclub.com), and is tailored for Hack Club Slack. This bot is not guaranteed to work outside of Hack Club Slack. + +--- + +## Running locally + +1. Copy `example.env` to `.env` and fill in all of the fields with your chosen API key(s). +2. Install the required Python modules with `pip3 install -r requirements.txt` +3. Run the bot with `python3 -m src.main` - this will start an HTTP server on port 8000 for OAuth along with running the Slack Bolt application! -- cgit v1.2.3